Skip to main content

Getting started

In four steps you go from having no access to trying any endpoint of the API.

Request your credentials​

To integrate you need a client_id / client_secret pair. Request it from the Volao team.

warning

Never expose your client_secret in browser code or public repositories.

Get a token​

Request
curl -X POST https://api.volao.app/api/auth/client/login \
  -H "Content-Type: application/json" \
  -d '{ "client_id": "client_demo", "client_secret": "secret_demo" }'

The response includes the token in token.access_token:

Response
{
  "response_code": 200,
  "response_status": "success",
  "response_message": "Autenticación API exitosa",
  "token": {
    "access_token": "<access_token>",
    "token_type": "Bearer",
    "expires_in": 900
  }
}

The token lasts 15 minutes. See Authentication to learn how to handle its expiration.

Call a protected endpoint​

Send the token in the Authorization header. For example, to list the available couriers:

Request with token
curl https://api.volao.app/api/courier \
  -H "Authorization: Bearer <access_token>"

See the API reference in the top bar for every available endpoint and the parameters each one requires.

Try the API from Postman or Apidog​

You can import every endpoint, with its parameters and examples, from the API's OpenAPI specification:

  • Specification URL: https://docs.volao.app/restApis.en.json
  • File: in the API reference, Introduction page, Export › OpenAPI Spec button.

The quickest way is the Export API menu in the top bar. For Postman it downloads a ready-made collection: folders by area, variables and the token saved automatically. For Apidog it downloads the OpenAPI specification, its native format, with the endpoints in folders by area. After the download, it shows the steps to import the file.

ToolHow to import it
PostmanImport → drag the downloaded collection (or paste the specification URL).
ApidogSettings › Import Data → OpenAPI/Swagger → URL (or upload the file).

With the Postman collection, enter your client_id and client_secret in the collection Variables tab and send API client login: the token is saved automatically and every request uses it.

In Apidog, to save the token automatically, add an Extract Variable post processor to API client login with the name access_token and the JSONPath $.token.access_token, and use {{access_token}} as the Bearer Token.

With the OpenAPI file in another tool, after importing:

  1. Run API client login with your credentials and copy the access_token.
  2. Set it as a Bearer Token in the collection's authorization, so every request uses it.
  3. When it expires (15 minutes), repeat the login and update the token.
tip

Import the specification again when the API changes, to keep the endpoints up to date.