Frequently Asked Questions
What are the daily API limits or “API Calls”?
The API is not currently rate limited; we allow an unlimited number of requests per minute. However, we reserve the right to limit requests for specific resources in order to maintain a high quality of service for all customers. If you have additional questions about rate limiting, please contact us.
What security measures are in place?
The API requires that all communication takes place over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests. We use tokens that expire to authenticate access to the API.
How will you call the API?
The eCompliance API is a RESTful, HATEOAS enabled interface for accessing your eCMS data in JSON or XML format over HTTP. The API is intended to provide secure, predictable resource-based URLs making it simple to rapidly develop web and desktop applications that integrate with eCompliance.
What will the API return?
JSON is the preferred data interchange format for the eCompliance API, and all requests will return JSON by default. XML is also supported, and the desired format can be specified by HTTP Header. The API makes use of the standard set of HTTP response codes to indicate success/failure of requests. Where possible, errors will return information in the response about why the request failed.
How does it work? What do I need on my end?
You will need a developer on your side to write a custom application (aka a client or API broker or middleware) that can speak with our API and the customer application/database (sometimes also an API) to get and update information from our system, and vice-versa.
How does it get turned on?
Companies wishing to use the API must contact us to have it turned on for their organization.