Ir al contenido

Login

Entornobase_urlDescripción
Producciónhttps://app.firmeasy.legal/apiEntorno estable para clientes finales.
Pruebashttps://staging.firmeasy.legal/apiEntorno de validación y pruebas previas a producción.

El endpoint de login permite obtener el access token necesario para autenticar todas las llamadas posteriores al API de Firmeasy.

El user_integration_token es un identificador único para cada integración de cliente (pendiente confirmar detalle sobre su provisión y vigencia).

POST {{base_url}}/v1/auth/{{user_integration_token}}/login

Para autorizar el acceso a la API es necesario incluir el token de autenticación en el encabezado Authorization, utilizando el esquema Bearer. Además, el encabezado Content-Type debe especificar que el cuerpo de la solicitud (si lo hubiera) se envía en formato JSON.

ParámetroTipoDescripciónLímites
Content-TypestringEspecifica el tipo de contenido del cuerpo de la solicitud HTTP. Para las peticiones que incluyen datos JSON'application/json'

En el cuerpo de la solicitud se envían los parámetros necesarios para realizar la operación. Los campos marcados con * son obligatorios; los demás son opcionales según las necesidades de cada integración.

ParámetroTipoDescripciónLímites
email*stringDirección de correo electrónico del usuario que tiene acceso a la integración vía APIObligatorio
password*stringContraseña asociada al emailObligatorio
{
"email": "[email protected]",
"password": "contraseña_secreta"
}

Al autenticarse correctamente, se devuelve un access token de tipo Bearer que deberá ser utilizado en el encabezado Authorization para todas las peticiones posteriores.

{
"access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FwcCZWdhbC9hcGkvdjEvYXV0aC8xYzNmMTM4Yi0yMjAzLTQxOTMtOGQ1YyXQiOjE3NTA2ODgyODQsImV4cCI6MTcwibmJmIjoxNzUwNjg4Mjg0LCJqdGkiOiJoQ1lwic3ViIjoiMTAwIiwicHOWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9._W84a9SWmt9EiCOGh3S-oNY1QYI42rXVli1O-jUfDAg",
"token_type": "bearer",
"expires_in": 3600,
"served_from_cache": false
}

NombreTipoDescripción
accessstringAccess Token que debe incluirse en el header Authorization para futuras llamadas.
token_typestringTipo de token devuelto (siempre `bearer`).
expires_inintTiempo de vida del token en segundos.
served_from_cachebooleanIndica si la respuesta fue servida desde caché.