# RabbitMQ Integration (`brasil-scrapers/rabbitmq-integration`)

This integration processes data from an Apify dataset and delivers it to a RabbitMQ queue. It is configured via a schema that includes details about the dataset and RabbitMQ connection settings.

- **URL**: https://beta-securitybyobscurity.apify.com/brasil-scrapers/rabbitmq-integration.md
- **Developed by:** [Brasil Scrapers](https://beta-securitybyobscurity.apify.com/brasil-scrapers) (community)
- **Categories:** Integrations, Automation
- **Stats:** 1 total users, 1 monthly users, 0.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

$10.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.
You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors

# README

## Apify to RabbitMQ Integration

### Overview

This integration processes data from an Apify dataset and delivers it to a RabbitMQ queue. It is configured via a schema that includes details about the dataset and RabbitMQ connection settings.

### Input Schema

The input schema defines the configuration required to run the integration effectively. Below are the details of the schema and its properties:

#### Schema Details

- **Title**: Apify to RabbitMQ Input Schema
- **Type**: Object
- **Schema Version**: 1

#### Properties

##### 1. **Default Dataset ID**

- **Title**: Default Dataset ID
- **Type**: String
- **Description**: The ID of the Apify dataset to process.
- **Default**: `default`
- **Editor**: Textfield

##### 2. **RabbitMQ Configuration**

- **Title**: RabbitMQ Configuration
- **Type**: Object
- **Description**: Configuration settings for RabbitMQ connection.
- **Editor**: JSON
- **Default**:
  ```json
  {
      "url": "amqp://localhost",
      "queue": "test-queue"
  }
  ```
- **Properties**:
  - **URL**:
    - **Title**: URL
    - **Type**: String
    - **Description**: RabbitMQ connection URL.
    - **Default**: `amqp://localhost`
  - **Queue**:
    - **Title**: Queue
    - **Type**: String
    - **Description**: RabbitMQ queue name.
    - **Default**: `test-queue`

#### Required Properties

- `defaultDatasetId`
- `rabbitConfig`

### Example Configuration

```json
{
    "defaultDatasetId": "my-dataset-id",
    "rabbitConfig": {
        "url": "amqp://user:password@rabbitmq-host",
        "queue": "my-queue"
    }
}
```

### How to Use

1. **Define the Input**: Provide the necessary configurations in JSON format as per the schema.
2. **Run the Integration**: Pass the configuration to the Apify actor or script responsible for processing and delivering the dataset to RabbitMQ.
3. **Monitor Outputs**: Check your RabbitMQ queue for incoming messages based on the processed dataset.

### Notes

- Ensure the RabbitMQ server is reachable from the environment where the integration is executed.
- The configuration assumes each message is published individually. Adjustments may be necessary for high-throughput use cases.

***

With this setup, your Apify actor can seamlessly deliver data from an Apify dataset to a RabbitMQ queue.

# Actor input Schema

## `defaultDatasetId` (type: `string`):

The ID of the Apify dataset to process

## `rabbitConfig` (type: `object`):

Configuration settings for RabbitMQ connection

## Actor input object example

```json
{
  "defaultDatasetId": "default",
  "rabbitConfig": {
    "url": "amqp://myuser:mypassword@localhost:5672",
    "queue": "your-queue-name"
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "rabbitConfig": {
        "url": "amqp://myuser:mypassword@localhost:5672",
        "queue": "your-queue-name"
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("brasil-scrapers/rabbitmq-integration").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "rabbitConfig": {
        "url": "amqp://myuser:mypassword@localhost:5672",
        "queue": "your-queue-name",
    } }

# Run the Actor and wait for it to finish
run = client.actor("brasil-scrapers/rabbitmq-integration").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "rabbitConfig": {
    "url": "amqp://myuser:mypassword@localhost:5672",
    "queue": "your-queue-name"
  }
}' |
apify call brasil-scrapers/rabbitmq-integration --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=brasil-scrapers/rabbitmq-integration",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "RabbitMQ Integration",
        "description": "This integration processes data from an Apify dataset and delivers it to a RabbitMQ queue. It is configured via a schema that includes details about the dataset and RabbitMQ connection settings.",
        "version": "0.1",
        "x-build-id": "P5Gid86awRg3suqAc"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/brasil-scrapers~rabbitmq-integration/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-brasil-scrapers-rabbitmq-integration",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/brasil-scrapers~rabbitmq-integration/runs": {
            "post": {
                "operationId": "runs-sync-brasil-scrapers-rabbitmq-integration",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/brasil-scrapers~rabbitmq-integration/run-sync": {
            "post": {
                "operationId": "run-sync-brasil-scrapers-rabbitmq-integration",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "defaultDatasetId",
                    "rabbitConfig"
                ],
                "properties": {
                    "defaultDatasetId": {
                        "title": "Default Dataset ID",
                        "type": "string",
                        "description": "The ID of the Apify dataset to process",
                        "default": "default"
                    },
                    "rabbitConfig": {
                        "title": "RabbitMQ Configuration",
                        "type": "object",
                        "description": "Configuration settings for RabbitMQ connection",
                        "default": {
                            "url": "amqp://myuser:mypassword@localhost:5672",
                            "queue": "your-queue-name"
                        }
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
