MICEtribe APIs are RESTful APIs with JSON responses only.
All API requests must send the following request headers:
Content-Type: application/json
Accept: application/json
API names will follow Kebab case in naming conventions, all APIs should be saved under specific version, will start with v1 e.g /v1/event-personas
API json payload and response bodies will follow Snake case e.g session_id
To ensure fair and reliable access for all developers, the MICEtribe API enforces a rate limit of 30 requests per minute. This limit helps prevent resource overuse and ensures consistent performance for all integrations.
Pagination is mandatory for all GET endpoints that return multiple objects in one response.
Pagination is controlled using the following query parameters:
per_page: Specifies the number of records per page (maximum: 100).
page: Indicates the page number to retrieve and it always starts from 1.
JSON response object wiill have the following attributes:
Errors: OBJECT ARRAY ( optional) A hash of each attribute and an array of messages for that attribute.
Message: STRING ( Always) Describes the problem.
- OK 200: All is well.
- Unauthorized 401: Your request is not authenticated.
- Forbidden 403: Your request is not authorized as the user has insufficient permissions.
- Page not found 404: The endpoint requested does not exist.
- Unprocessable entity 422: The resource couldn't be created or updated due to a validation error. Please see the response body for more information.
- Too many requests 429: Your application is exceeding its rate limit. Slow down, pal!
- Internal server error 500: Something is wrong on our end.
- Bad gateway 502: The app responsible for serving your request is temporarily unavailable.
- Gateway timeout 504: Something has timed out on our end.
- Live environemnt base_url: https://api.micetribe.com/integrations/v1
- Sandbox environment base_url: https://api.staging.micetribe.com/integrations/v1
Tokens are generated per event scope. Every new event must have it's new generated token.
All API requests should be made over SSL, and API token authenticated endpoints MUST only be called from back-side code for secruity reason.
API token grant access to data in your MICEtribe organization and should be treated as passwords.
API tokens should only be shared with trusted parties in a secure manner.
Every token generated will have defined scopes aliged to it. It define the level of data access to the event's data. We build it to have full control over registrations, zone and analytics (Read and Write access per each part).
Highly recommended to only request as much data access as your app needs to work. Highly advised not to give full access to everything in your event.