Login Endpoint

POST/login

Autenticación de usuario para obtener token de acceso

Objetivo

Utilizar las credenciales que fueron enviadas para iniciar sesión. Una vez autenticado, se utiliza el token obtenido para poder conectarse con los distintos endpoints disponibles. Las credenciales son únicas por cada cliente de tapi y por cada país en el que opera.

Request

Headers

Este endpoint no tiene headers requeridos.

Body Parameters

Campo	Tipo	Obligatorio	Descripción
clientUsername	String	Sí	Nombre de usuario del cliente.
password	String	Sí	Contraseña del usuario.

Response

Response Body

Parámetro	Tipo	Descripción
accessToken	String	Token de acceso JWT para autenticación en otros endpoints.
refreshToken	String	Token de actualización para renovar el accessToken cuando expire.
tx	String	Identificador único de la transacción de login.
main_tx	String	Identificador principal de la transacción.

Response Examples

200 OK

Consideraciones

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, se lo 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.)
La API Key es particular para cada base URL del servicio (por ejemplo, una para login, otra para el resto), no por cada merchant o biller.
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.
Las credenciales (usuario/contraseña) y las API Keys son diferentes para el ambiente de Producción. Además son diferentes por país en caso de que un cliente requiera acceso multiregión.
Si el token recibido se vence, es necesario generar uno nuevo llamando nuevamente al servicio de login. Es posible generar múltiples tokens si es necesario.
La validez del token en producción es de 4 minutos.

CLIENT LIBRARIES

REQUEST EXAMPLE

curl --request POST \
--url https://login.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"
}'

API Reference