Usage Guidelines
Inventory Management | Labor & Scheduling | Cruise
API Responses
This section lists the potential responses that an API request can return.
Response | Description |
---|---|
200 | Success |
207 | Partial Success |
400 | Validation Error |
401 | Authorization Error |
404 | Data Not Found |
500 | Unexpected |
503 | System Under Maintenance |
504 | Timeout |
API Limitations
Batch Size
- Our "Save" feature allows you to process up to 50 pieces of information at once. For example, when dealing with employee data, each entry can be handled separately, providing you with feedback on success or failure. Keep in mind that adjusting the number of elements in each exchange or the frequency of executions may impact performance differently.
- Our “List” feature has a hard limit of 500k records.
- Our “Page” feature has a default limit of 10 pieces of information per page.
Timeouts
- If an operation takes too long while processing incoming data through our API, a timeout (504) may occur. Each call has a 10-second limit for the necessary HTTP communication to complete the API processing. Additionally, there's a 4-second connect timeout, relevant only if the site is temporarily down or unreachable from a networking perspective.
Per Site/Route Concurrency Limits
- Each API customer can make up to 30 simultaneous API calls. This is not a daily or hourly limit; it applies only to the number of concurrent calls at any given moment. These limits govern the system's functionality and apply across all APIs.
Terms of Usage
Crunchtime may provide its customers and third-party integrators access to its application programming interface (API). Customers and third-party integrators may not use the API in a manner, as reasonably determined by Crunchtime, that exceeds reasonable request volume, constitutes excessive or abusive usage, or fails to comply with any part of the API. If any of these occur, Crunchtime can suspend or terminate access to the API on a temporary or permanent basis.
Crunchtime may change or remove existing endpoints or fields in the API upon at least 30 days' notice to the customer, but Crunchtime will use commercially reasonable efforts to support the previous version of the API for at least 6 months. Crunchtime may add new endpoints or fields in the API without prior notice to the customers and third-party integrators.
The API is provided on an AS-IS basis. Crunchtime has no liability to as a result of any change, temporary unavailability, suspension, or termination of access to the API.
Updated about 1 month ago