Before OpenAPI features can be enabled, you must agree to the applicable terms & conditions. You can review the terms & conditions below in addition to within the application.

Shepherd OpenAPI Terms & Conditions.pdf

OpenAPI usage incurs an added $35 monthly subscription fee.

To begin using Shepherd's OpenAPI, you'll first need to enable OpenAPI. Navigate to Admin -> Integrations -> OpenAPI to access the activation setting toggle.

For group accounts, OpenAPI access for clinic level usage must first be granted from the Multi-Location platform. The related setting, Enable Clinic Connections, can be found by following: Settings -> General while on the Multi-Location platform. Don't forget to save your election! OpenAPI access can be updated from the Multi-Location platform at any time.

Once Shepherd OpenAPI is enabled, you will see a new section for Key Sets appear. Here you can create new API key sets or manage existing sets.

To create a new key set select Add New Set within the grey canvas area along the left side. You'll be required to define a Set Name. When a new key set is created, you'll have full visibility to the private key. The private key will not be fully visible after initial creation. It is recommend you copy the private key and transfer it to your external connection configuration. When ready, select Save.

To enable a key set, ensure the toggle at the end of the key set row is toggled on.

To disable a key set, ensure the toggle at the end of the key set row is toggled off.

The private key of a key set is fully visible only when created or when refreshed for a new key. Select the Refresh Key button to generate a new private key.