Introducing Shepherd OpenAPI - Shepherd's newest user accessible OpenAPI feature! With our initial feature launch, we are aiming to explore and further understand the wide variety of user needs and use cases for our OpenAPI capabilities. Our goal is to enhance the Shepherd user experience by unlocking new possibilities for seamless data relay between Shepherd and custom developed external platforms. There will be no additional subscription cost for OpenAPI usage during the initial 2024 trial period. Additional subscription costs will apply beginning in 2025.
Please direct any OpenAPI related inquiries to OpenAPI@shepherd.vet for assistance.
Enable Connection
To begin using Shepherd's OpenAPI, you'll first need to enable OpenAPI. Navigate to Admin -> Integrations -> OpenAPI to access the activation setting toggle.
Multi-Location Setting Management
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.
Creating and Managing API Key Sets
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.
Creating New Key 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.
Enabling Key Sets
To enable a key set, ensure the toggle at the end of the key set row is toggled on.
Disabling Key Sets
To disable a key set, ensure the toggle at the end of the key set row is toggled off.
Accessing the Private Key
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.
API URLs & Documentation
Production Base URL: open-api.shepherd.vet/pav2
Production App URL: app.shepherd.vet
Production API Documentation: app.shepherd.vet/swagger