Introduction

This documentation describes the Cube-IQ / BlackBox REST API.

The APIs are HTTP-based RESTful APIs using BASIC authorization. API request and response bodies are formatted in JSON unless explicitly stated otherwise. The service supports CORS allowing cross-domain access from browser-based clients.

The API provides two separate services, namely:

1. Read/write of a Cube-IQ database residing on the server by connecting the client software to a Cube-IQ EDB Database.

2. Send optimization requests to a BlackBox optimizer for load planning / palletization / cartonization purposes. It is multi-threaded and able to handle any number of parallel connections. It will cater for queuing and can both load balance and scale.

You will need to reference the JSON and/or XML schemas in order to use either API.

Important: You cannot run the sample requests in this guide as-is. Replace call-specific parameters such as tokens and IDs with your own values.

For definitions of common REST API terms, see the Glossary.

Note: example responses are not included in this documentation due to size considerations. Please contact MagicLogic for samples and documentation on the JSON schema.