Autenticación
Método: POST
Endpoint
Sección titulada «Endpoint»https://api.ventasremotas.com/v1/tokenDescripción
Sección titulada «Descripción»Este endpoint proporciona un token de acceso que permite validar las solicitudes realizadas a la API utilizando las credenciales del sistema.
- Función: Verificar la identidad del usuario y emitir un token de acceso activo.
- Vigencia del token: 1 hora. Después de este tiempo, deberá solicitarse uno nuevo para continuar usando los servicios.
- Importante: El token es requerido para consumir cualquier endpoint que cuente con protección dentro de la API.
Encabezados de la solicitud
Sección titulada «Encabezados de la solicitud»| Header | Valor | Descripción |
|---|---|---|
Content-Type | application/json | Indica que los datos se envían en formato JSON |
Accept | application/json | Indica que la respuesta debe estar en formato JSON |
Subscription-Key | {subscription_key} | Token de acceso para autenticación |
Parámetros del Cuerpo (Body)
Sección titulada «Parámetros del Cuerpo (Body)»El cuerpo de la solicitud debe enviarse como JSON e incluir los siguientes parámetros obligatorios:
| Campo | Descripción |
|---|---|
client_id | Identificador único del cliente |
client_secret | Secreto asociado al cliente |
Ejemplo de Solicitud
Sección titulada «Ejemplo de Solicitud»Aquí tienes un ejemplo de cómo debería quedar el cuerpo de la solicitud en formato JSON:
{ "client_id": "xxxxx-3838-42fa-bcf2-xxxxx", "client_secret": "3256~k511nokkxfgg7nwPUCaznwh23yh~QxJLO9cDq"}Ejemplo de Respuesta
Sección titulada «Ejemplo de Respuesta»{ "token_type": "Bearer", "expires_in": 3600, "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsIng1dCI6Inr..."}| Campo | Descripción |
|---|---|
token_type | Tipo de token (siempre “Bearer”) |
expires_in | Tiempo de expiración en segundos (3600 = 1 hora) |
access_token | Token JWT para usar en las solicitudes autenticadas |
JSON inválido
Sección titulada «JSON inválido»{ "statusCode": 400, "errors": [ { "message": "Invalid JSON in request body" } ]}Credenciales faltantes
Sección titulada «Credenciales faltantes»{ "statusCode": 400, "errors": [ { "message": "Missing client_id or client_secret" } ]}| Error | Descripción |
|---|---|
Invalid JSON in request body | El cuerpo de la solicitud no es un JSON válido |
Missing client_id or client_secret | No se enviaron las credenciales requeridas |
Credenciales inválidas
Sección titulada «Credenciales inválidas»{ "statusCode": 401, "errors": [ { "message": "Invalid client credentials" } ]}Credenciales no encontradas
Sección titulada «Credenciales no encontradas»{ "statusCode": 404, "errors": [ { "message": "Not found client credentials" } ]}Error de conexión a la base de datos
Sección titulada «Error de conexión a la base de datos»{ "statusCode": 500, "errors": [ { "message": "Error connecting to database" } ]}Error en operación de base de datos
Sección titulada «Error en operación de base de datos»{ "statusCode": 500, "errors": [ { "message": "Database operation failed" } ]}Error inesperado
Sección titulada «Error inesperado»{ "statusCode": 500, "errors": [ { "message": "Unexpected error" } ]}| Error | Descripción |
|---|---|
Error connecting to database | No se pudo establecer conexión con la base de datos |
Database operation failed | Falló una operación durante la consulta a la base de datos |
Unexpected error | Ocurrió un error no controlado en el servidor |