The Record360 Integration API — also known as the v3 REST API — uses standard http verbs to communicate and http status codes to indicate status and error. All responses come in standard JSON. The API is served over HTTPS to ensure data privacy; HTTP is not supported.

Backwards-compatible changes

We consider the following changes to be backwards-compatible:

Adding new API resources.
Adding new optional request parameters to existing API methods.
Adding new optional properties to existing API request bodies.
Making required properties in existing API request bodies optional.
Adding new properties to existing API responses.
Changing the order of properties in existing API responses.
Changing the length or format of object IDs or other opaque strings.
- Ensure that your integration can handle Record360-generated object IDs, which can contain up to 255 characters. For example, if you’re using MySQL, store the IDs in a VARCHAR(255) COLLATE utf8_bin column (the COLLATE configuration provides case-sensitivity during lookups).
Adding new event types.
- Ensure that your webhook listener gracefully handles unfamiliar event types.

Errors

Record360 uses standard HTTP status codes to indicate request success or failure. When present, the body of the response will be JSON in the following format:

{
  "errors": "The Unit A-001 could not be found"
}

Rate limiting

Record360 enforces a default rate limit of 100 requests per 10 seconds per IP. Rate limit may be increased to 200 requests per 10 seconds per IP upon discussion. If the rate limit is exceeded, a 429 response is returned with a Retry-After header that indicates when requests will be allowed for that client again.

Beta features

Record360 may provide new API features via beta features. This allows early adopters to opt-in for the latest and greatest and for us to collect feedback before a feature is made generally available (GA). We believe in stability without stagnation. Beta testing allows our team to build and ship best-in-class APIs faster, while upholding backwards-compatibility on GA features.

Beta features are subject to change, and thus, are exempt from any backwards-compatibility guarantees. We do not expect nor recommend using experimental features in production environments except when our teams are working closely together.

Beta features are marked with this badge on the endpoint page:

⏳
Beta Features
Some Integration API features are currently in beta and may be subject to change. We appreciate you, as our partners, providing feedback and helping improve the platform. Occasionally, breaking changes may be required, but will only be made with direct contact and adequate forewarning to affected users.