Login
Entornos
Sección titulada «Entornos»| Entorno | base_url | Descripción |
|---|---|---|
| Producción | https://app.firmeasy.legal/api | Entorno estable para clientes finales. |
| Pruebas | https://staging.firmeasy.legal/api | Entorno de validación y pruebas previas a producción. |
Autenticación: Login
Sección titulada «Autenticación: Login»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}}/loginHeaders
Sección titulada «Headers»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ámetro | Tipo | Descripción | Límites |
|---|---|---|---|
Content-Type | string | Especifica el tipo de contenido del cuerpo de la solicitud HTTP. Para las peticiones que incluyen datos JSON | 'application/json' |
Cuerpo de la solicitud
Sección titulada «Cuerpo de la solicitud»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ámetro | Tipo | Descripción | Límites |
|---|---|---|---|
email* | string | Dirección de correo electrónico del usuario que tiene acceso a la integración vía API | Obligatorio |
password* | string | Contraseña asociada al email | Obligatorio |
Ejemplo de request
Sección titulada «Ejemplo de request»{ "password": "contraseña_secreta"}Respuesta exitosa
Sección titulada «Respuesta exitosa»Al autenticarse correctamente, se devuelve un access token de tipo Bearer que deberá ser utilizado en el encabezado Authorization para todas las peticiones posteriores.
Ejemplo de respuesta
Sección titulada «Ejemplo de respuesta»{ "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FwcCZWdhbC9hcGkvdjEvYXV0aC8xYzNmMTM4Yi0yMjAzLTQxOTMtOGQ1YyXQiOjE3NTA2ODgyODQsImV4cCI6MTcwibmJmIjoxNzUwNjg4Mjg0LCJqdGkiOiJoQ1lwic3ViIjoiMTAwIiwicHOWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9._W84a9SWmt9EiCOGh3S-oNY1QYI42rXVli1O-jUfDAg", "token_type": "bearer", "expires_in": 3600, "served_from_cache": false}Campos devueltos
Sección titulada «Campos devueltos»| Nombre | Tipo | Descripción |
|---|---|---|
access | string | Access Token que debe incluirse en el header Authorization para futuras llamadas. |
token_type | string | Tipo de token devuelto (siempre `bearer`). |
expires_in | int | Tiempo de vida del token en segundos. |
served_from_cache | boolean | Indica si la respuesta fue servida desde caché. |
