Getting started with and making a request from the Vepple API can be done in a few simple steps.

Getting set up

1. First send us a request to have an admin account created for your Vepple API through the help desk. We will send you some log in information and a project id that will be unique to your Vepple.
2. Using the project id we provide navigate to the following URL:
   https://europe-west2-rv-vepple-api.cloudfunctions.net/api/<YOUR-PROJECT-ID>
3. This should return a page showing the different endpoints that you can access on your API and the expected data each one should return.

Making requests

To ensure that all data we keep is kept private we require an authentication token on each request to your API that you make, this is done with the following steps:

1. At the url below make a post request with the log in information we give you as body contents e.g. :
   https://europe-west2-rv-vepple-api.cloudfunctions.net/api/<YOUR-PROJECT-ID>/auth
   With a body of:
   { email: <YOUR-PROVIDED-EMAIL>, password: <YOUR-PROVIDED-PASSWORD> }
2. This will return an authentication token which will remain active for 60 minutes after you receive it.
3. Using this token you can then navigate to any of the endpoints in the API, setting the token we provided as your bearer token in the request.
4. This will return a JSON object with any information you requested.