Skip to main content

API Access

Learn how to interact with CAVO® through our API

Emily McMakin avatar
Written by Emily McMakin
Updated over a year ago

It's possible to integrate your backend systems with CAVO® by utilizing our RESTful API. 

Sandbox

While you are learning about our API, you will have access to a sandbox instance. This is a common instance shared by all developers. Because of this set up, it's important that you do not send any documents that contain PHI.

Anything sent to the sandbox is accessible by all developers.

To gain access to the developer sandbox, send an email to support@cavo.io including your first and last name, email address, phone number, and company name. We will register you with our Developer Sandbox.

Production

Once your APIs are tested and ready to go, change your API Keys and target domain to your active instance. If your company is ACME, your instance is likely acme.cavo.io . You will need to login to your CAVO® instance with a Developer role. This can be assigned to you by emailing a request to support@cavo.io. Please include your CAVO® instance name,  first and last name, email address, and phone number with your request.

Once the Developer role has been assigned to you, log in to your CAVO® instance and access the API Documentation link from the drop down menu on the left side of the screen

You can manage your API keys and browse the various provided endpoints. Keep in mind that any active API keys could be in use; in particular, if CAVO® is currently running document imports, we use an API key for this operation. You may either add a new API key or use the existing API key. If you create a new key, be sure to name it something useful to you. (Note: We allow a maximum of two (2) active API keys.) Click the lock to reveal the password. The Key and the Password are hashed together per standard HTTP Basic Auth procedures and sent as a header to validate each request.

There are no hard request/sec limits. For support, please click the Chat Bubble in the upper right and ask for a staff member on the CAVO® software developer team.

Did this answer your question?