Authenticate

Send your key and secret with every request.

The Prospera Books API uses token authentication. Your administrator generates an API key and secret for the integration user. Send both in the Authorization header of every request, over HTTPS.

1. Generate the key

   In Prospera Books, open the user, go to Settings and select Generate Keys in the API access section. Copy the secret straight away; it is shown once.

2. Send the header

   Add this header to every request:

   Authorization: token :

3. Check the connection

   A quick check that needs no key:

   curl https:///api/method/ping
   
   {"message": "pong"}

4. Handle refusals

   A request without a valid key, or for a record the user may not see, returns HTTP 403 with a permission error. Check the user’s roles before anything else.