Quick start
This section to include an overview, how the documentation is split, and about the sandbox and registration.
Endpoints
The DataVet API has two endpoints:
Sandbox: https://sandbox.datavet.co.uk/ (used for testing and development)
Production: https://api.datavet.co.uk/ (used for production data)
Authentication
All requests to api routes require JSON web tokens (jwts) to be sent in an authorisation header.
By sumbitting your account credentials to the API (see authentication) you will be returned a JSON web token.
At present, all accounts must be requested through our help page.
Requests
All the requests shown in this documentation follow the below format (very similar to curl):
REQUEST_METHOD REQUEST_PATH ARGUMENTS
REQUEST_METHOD: the method to use either POST, GET, PUT or DELETE
REQUEST_PATH: the path to the resource (you will need to prefix with either the sandbox or production URI)
ARGUMENTS: additional arguments to the request (these are shown in curl format), such as header or data.
DATA: data in the body will be shown beneath the request like so:
{
"name": "Post Data",
"description": "This shows the post data format within the docs"
}