API Details

The Versium REACH API was developed following RESTful principles and defaults to returning JSON responses. For customization options, refer to the Common API Parameters.

Case Sensitivity

To understand the case-sensitivity rules, refer to the documentation on API Case Sensitivity.

Common Approaches

The API follows standard practices for the following aspects::

FunctionDescription
DataAPI data is JSON encoded with UTF-8. API JSON is either a single object or a list of objects.
AuthenticationAccess control using API Key in the header.
Errors4xx and 5xx responses returning JSON with error messages. See HTTP Status Codes for details.
Rate LimitingControls how many requests can be made in a time window
HTTP/HTTPSMethods are used in accordance with HTTP (GET, POST and DELETE are the primary methods used) and resources are identified using URIs. All API requests are sent over HTTPS.