Direct Data Broker Access
In addition to the REST API, the Shoplogix IMS platform offers direct MQTT broker access for customers who need high-throughput, low-latency sensor data streaming without polling.
This integration path is best suited for customers with existing MQTT infrastructure — for example, a data historian, OT platform, or stream processing system that can consume directly from a message broker.
Direct AMQP access is not offered. The broker is RabbitMQ internally, but customer-facing streaming connections are MQTT only.
How It Works
Each customer account has a dedicated RabbitMQ virtual host (vhost) on the Shoplogix cloud broker. Sensor data is routed to your vhost as it arrives from the field. You connect directly to the broker using credentials you obtain via the API.
Supported Protocols
| Protocol | Port | Notes |
|---|---|---|
| MQTT (TLS) | 8883 | Recommended — encrypted |
Getting Credentials
Dynamic Credentials (Temporary)
Dynamic credentials are time-limited and issued on demand. Use these for applications where credential rotation is acceptable or preferred.
Request via API:
GET /v2020-07/brokers/{id}
Response includes:
| Field | Description |
|---|---|
username | Broker username |
secret | Broker password |
ttl | Credential lifetime in seconds |
leaseId | Lease identifier for tracking |
host | Public broker hostname |
privateHost | Private/VPC broker hostname |
mqttPort | MQTT port |
vhost | Your dedicated virtual host |
CAchainB64 | Base64-encoded CA certificate chain |
Before your credentials expire, request a new lease to stay connected without interruption. Default TTL is 7,200 seconds (2 hours).
Static Credentials (Permanent)
Static credentials do not expire. Use these for long-running services where automatic rotation is not practical.
Contact your Shoplogix account team to request static credentials.
Listing Available Brokers
GET /v2020-07/brokers
You can filter by broker name, customer ID, customer name, or customer status. The response lists the brokers associated with your account.
Requirements
- Your application must be able to establish outbound connections on the MQTT port to the broker hostname
- Use the CA certificate chain (
CAchainB64) to validate the broker's TLS certificate - The Developer role is required to manage API credentials and broker access
Choosing Between REST API and Broker Access
| Use Case | Best Path |
|---|---|
| Querying current state or historical data | REST API |
| Receiving events on state changes | Webhooks |
| Streaming all sensor readings as they arrive | Data Broker (MQTT) |
| Low-latency feed into OT/SCADA | Data Broker (MQTT) |
Contact your Shoplogix account team to enable broker access for your account.