Solicitud de acceso

Para empezar a utilizar la API se requiere solicitar acceso al mail api@arcadienvios.com, con dicho acceso se podrá obtener un token para interactuar con la API.

Información importante

Para los endpoints que manipulan tokens se requiere usar una autenticación básica con el Client ID como usuario y Secret Key como contraseña los cuales se le otorgó al solicitar acceso.

Obtener Token

Endpoint:

    
POST /api/v3/auth/authorize HTTP/1.1
Authorization: Basic client_id client_secret

    
  

Respuestas de ejemplo:

Respuesta 200

    
{
  "token": "xxxxx....",
  "expires_at": "2024-05-08T04:56:44.763-04:00",
}

    
  

Respuesta 401

    
{
  "message": "invalid credentials"
}

    
  

Refrescar Token

En caso de ser necesario se puede refrescar un token y extender el tiempo en el que se expira.

Endpoint

    
POST /api/v3/auth/refresh HTTP/1.1
Authorization: Basic client_id client_secret
Content-Type: application/json

{ "token": "Token previamente generado" }

    
  

Respuestas de ejemplo

Respuesta 200

    
{
  "token": "xxx...",
  "expires_at": "2024-04-19T23:31:01.171-04:00"
}

    
  

Respuesta 401

    
{
  "message": "invalid credentials"
}

    
  

Respuesta 404

    
{
  "message": "record_not_found"
}

    
  

Desactivar Token

Si existe la necesidad se puede desactivar un token en particular. Nota: Los token son desactivados automáticamente cuando expiran.

Endpoint

    
DELETE /api/v3/auth/destroy HTTP/1.1
Authorization: Basic client_id client_secret
Content-Type: application/json

{ "token": "Token generado" }

    
  

Uso del Token

El token funciona como bearer token, y debe enviarse en el header como tal. Este token es requerido dentro de toda la API excepto la sección de autenticación.