Welcome to the V2 API.
This section is designed to host an array of useful information, tools and examples on how to use this API
The API is based upon Swagger IO / Open API set of tools, and we have provided the Public YAML Document as well as Documentation
Please use the navigation above to find out more about the API, and please feel free to Provide Feedback!
This API is an Applications Programming Interface, and is intended for consumers who wish to automate some aspects of managing their data.
It's a REST API and is based on the popular Swagger Framework.
Encoding: The encoding that's used in the API is UTF-8, and you should ensure that you set this encoding in connections made.
Provided with this kit is the following :-
Access to the API can be provided, please contact support@vetspace.com to arrange for access.
The authentication service provides methods for acquiring access tokens that give you access to all other services.
The login method must be called with valid api keys before you can call any method on any of the other services. This method will return an access token which must then be submitted on subsequent calls in the ApiToken header to prove you have been successfully authenticated. Access tokens have a limited lifespan and will need to be renewed periodically. This can be done by simply calling the login method again.
Some methods require you to act on behalf of a user and these require an extra level of authentication. For methods that require an ApiUserToken header you will first need to call the verifyUser method with the user's username and password. This method will return a user access token which can then be used to call these methods. User access tokens have a limited lifespan and will need to be renewed periodically.
The Mobile Service is a general use service.
The global service allows for managing of global accounts. This service is required if you need to provide seamless functionality across multiple veterinary groups. This service provides methods for creating global accounts, connecting accounts to practices and sites and password management.
The Mobile Service is a vet-facing service.
Exposes functionality required by the Vetspace mobile application.
The managed bookings service is a vet-facing service.
The managed bookings service allows you to create and manage appointments. It provides methods for searching clients, searching availability, creating, updating and cancelling appointments.
This service is intended to enable Customers to create accounts with a veterinary group.
The registrations service provides the ability to register new clients with a veterinary group. This service provides a number of methods to retrieve data in order to build a registration form, such as lists of allowed titles, cities etc. There is also a method to see if a client with matching details already exists. Finally this service provides a method which will take the data gathered about the client and register that client with the veterinary group.
This service is an Customer facing service, providing information as a Customer to a practice.
The ClientLink service has methods for providing a portal experience, using a global registration system it allows customers access to their data at their vet.
This service also provides methods for enhancing a Vets website by providing access to information such as average waiting times and surgeon availability.
Powers the My Vets Diary application.
The clinical portal service is a vet-facing service.
This service allows retrieval of data in order to provide a portal of key information for the user, including appointments, prescriptions, reminders etc.
Help and support is available via the support team, and you also can try each API call via our Try It Yourself page
Access to the API can be provided, please contact support@vetspace.com to arrange for access.
Latest Release Notes.
If you have any questions about the API or usage, please contact support@vetspace.com.