Conventions and best practices
Rate limits
At present, there are no limitations on API usage. However, please note that we reserve the right to introduce usage limitations or restrictions in the future to maintain the overall performance and align with our commercial policies. Any such changes will be communicated in advance, and we will work transparently with our user community to ensure a smooth transition..
Fair usage: any misuse or abuse of the API, including but not limited to excessive requests, unauthorized access, or any activity that violates our terms of service, will result in the removal of access privileges.
Versioning
Seamless Handoff API uses the URI Versioning strategy. The current API version is v1. See the Integration setup page for more details.
HTTP status codes
HTTP status code | Description |
|---|---|
200 | The request succeeded. |
201 | The request succeeded and resources was created. |
202 | The request has been accepted for processing. |
400 | The request was malformed or otherwise incorrect. |
404 | The requested resource was not found. |
429 | The request was above the allowed rate limit |
500 | The request failed due to an internal server error. |
Errors
The error responses, alongside the relevant status code (4xx or 5xx), return the description of the problem. The problem description is formatted as a Problem Details JSON Object defined by RFC 9457. Details the error of a HTTP response as defined by RFC 9457.Problem Detail