This article explains BASIC authentication and user access levels, detailing the permissions required to interact with different API services. Rate limits are also covered to ensure efficient API usage.
User Roles and Permissions
All API calls require BASIC authentication using credentials supplied by MagicLogic. API access rights define the available operations:
| Access Level | Database Service | Optimizer Service |
| ADMIN | Create, edit, view, and unlock loads | Optimize, get status, list jobs, force user logout, view users |
| CREATE | Create, edit, and view loads | Optimize, get status |
| EDIT | Edit and view loads | Optimize only |
| VIEW | View loads only | Not allowed |
Rate Limits
Requests to MagicLogic's servers have the following rate limits:
- List items from the database: One request per second
- Retrieve data from the database: One request per second
- Store data in the database: One request per second
- Optimize requests: Two requests per second
- Get optimization progress: One request per second (until completion)
- Retrieve optimization results: One request per optimization call (upon completion)
- Fetch log messages: One request per minute
Note: No rate limits apply when hosting the service on a private server.