Endpoint de Autenticación

POST/login

Autenticar usuario y obtener token de acceso

Objetivo

El endpoint /login permite autenticar un usuario en el sistema utilizando sus credenciales (usuario y contraseña) y obtener un token de autorización que será necesario para realizar llamadas a otros endpoints de la API.

Request

Headers

Este endpoint no tiene headers requeridos.

Body Parameters

Parámetro	Tipo	Requerido	Descripción
clientUsername	String	Sí	Nombre de usuario proporcionado para el acceso.
password	String	Sí	Contraseña del usuario.

Response

Response Body

Parámetro	Tipo	Descripción
accessToken	String	Token de acceso JWT para autenticar futuras peticiones
refreshToken	String	Token de actualización para obtener nuevos tokens de acceso
tx	String	Identificador único de la transacción de autenticación
main_tx	String	Identificador de la transacción principal

Response Examples

200 OK

400 Bad Request

Consideraciones

El accessToken tiene una duración de 5 horas desde su emisión.
En caso de que la respuesta a este endpoint sea satisfactoria, se deberá utilizar el 'accessToken' para acceder a los otros servicios brindados.
En el header de los otros servicios, el token se denomina como 'x-authorization-token'.
El access token y el API key son campos requeridos en el header para llamar a la mayoría de los otros endpoints de Tapi (companies, debt, payment, agenda, etc.).
Actualmente, el endpoint de login no solo devuelve el access token. El refresh token está disponible en la API pero no se está utilizando por el momento.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://auth.homo.tapila.cloud/login \
--header 'x-authorization-token: YOUR_TOKEN_HERE' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data '{
  "clientUsername": "john.doe",
  "password": "My.pass.12345678"
}'

Referencia API