Primeros pasos
En cuatro pasos pasas de no tener acceso a probar cualquier endpoint de la API.
Solicita tus credenciales
Para integrarte necesitas un par client_id / client_secret. Solicítalo al equipo de Volao.
Nunca expongas tu client_secret en código del navegador o en repositorios públicos.
Obtén un token
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" }'
La respuesta incluye el token en token.access_token:
{
"response_code": 200,
"response_status": "success",
"response_message": "Autenticación API exitosa",
"token": {
"access_token": "<access_token>",
"token_type": "Bearer",
"expires_in": 900
}
}
El token dura 15 minutos. Consulta Autenticación para saber cómo manejar su vencimiento.
Llama a un endpoint protegido
Envía el token en el header Authorization. Por ejemplo, para listar los couriers disponibles:
curl https://api.volao.app/api/courier \
-H "Authorization: Bearer <access_token>"
Consulta la Referencia API en la barra superior para ver todos los endpoints disponibles y los parámetros que requiere cada uno.
Prueba la API desde Postman o Apidog
Puedes importar todos los endpoints, con sus parámetros y ejemplos, desde la especificación OpenAPI de la API:
- URL de la especificación:
https://docs.volao.app/restApis.json - Archivo: en la Referencia API, página Introducción, botón Exportar › Especificación OpenAPI.
La forma más rápida es el menú Exportar API de la barra superior. Para Postman descarga una colección lista: carpetas por área, variables y el token guardado automáticamente. Para Apidog descarga la especificación OpenAPI, su formato nativo, con los endpoints en carpetas por área. Al descargar, te muestra los pasos para importar el archivo.
| Herramienta | Cómo importarla |
|---|---|
| Postman | Import → arrastra la colección descargada (o pega la URL de la especificación). |
| Apidog | Settings › Import Data → OpenAPI/Swagger → URL (o sube el archivo). |
Con la colección de Postman, pon tu client_id y tu client_secret en la pestaña Variables de la colección y envía Login de cliente API: el token se guarda solo y lo usan todas las peticiones.
En Apidog, para que el token se guarde solo, agrega a Login de cliente API un post-procesador Extract Variable con el nombre access_token y el JSONPath $.token.access_token, y usa {{access_token}} como Bearer Token.
Con el archivo OpenAPI en otra herramienta, después de importar:
- Ejecuta Login de cliente API con tus credenciales y copia el
access_token. - Configúralo como Bearer Token en la autorización de la colección, para que lo usen todas las peticiones.
- Cuando venza (15 minutos), repite el login y actualiza el token.
Vuelve a importar la especificación cuando la API cambie, para tener los endpoints al día.