[API] Cómo autenticarse en la API de Optiroute

Autenticación


La autenticación es el mecanismo que asocia una llamada entrante a una API REST con una credencial de identificación de tipo token. Nuestro sistema usa esta credencial para determinar si se debe permitir la solicitud a la API, para de esta manera controlar que solo los usuarios autorizados tengan acceso a nuestro servicio.


Autenticación por Token


El modelo de autenticación utilizado en todos los servicios de API Optiroute corresponden al modelo de autenticación HTTP basado en token. Este token corresponde a un string alfanumérico como el siguiente:


9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b


Obtener Token de autenticación


Para obtener el Token de autorización puedes hacer un llamada de tipo POST con las credenciales de tu cuenta Optiroute válida al siguiente endpoint:


https://app.optiroute.cl/api-token-auth/


Debes agregar las credenciales de acceso a la plataforma como información de autenticación en el form-data de la llamada.


Propiedad

Tipo

Descripción

Requerido

username

String

Correo del usuario de la cuenta. Usado para el ingreso en la plataforma

Requerido

password

String

Password del usuario de la cuenta. Usado para el ingreso en la plataforma

Requerido


Autenticación de llamadas


Una vez obtenido el token de autenticación este debe ser incluido en cada una de las llamadas HTTP que se realicen a Optiroute para autenticar el acceso a la plataforma.


Cada llamada debe tener una encabezado con la llave Authorization cuyo valor debe corresponder a un string conformado por el prefijo “Token” seguido de un espacio en blanco unido al código token que se obtuvo en el paso anterior. Por ejemplo:


Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b


Es posible utilizar la herramienta de línea de comandos curl para probar el acceso a los endpoint que utilizan la autenticación con token


Por ejemplo:

curl -X GET https://app.optiroute.cl/api/v1/some-endpoint/ -H 'Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b'