POST
Iniciar sesión

Cuerpo

application/json
email
string
predeterminado:usuario@tuempresa.com
requerido

Email de sesión

Ejemplo:

"usuario@tuempresa.com"

password
string
predeterminado:tu-contraseña
requerido

Contraseña de sesión

Ejemplo:

"tu-contraseña"

Respuesta

200 - application/json

Éxito

Envoltorio común a todas las respuestas. status no se deduce del código HTTP: hay al menos nueve lugares en el gateway que responden HTTP 200 con status: "FAIL" (por ejemplo CFE_NOT_FOUND y DGI_COMPANY_NOT_READY_YET). Un cliente tiene que leer status, no el código.

payload
requerido

Los datos de la respuesta. {} cuando el endpoint no devuelve nada.

status
enum<string>
requerido

De las 82 claves de mensaje del gateway, 29 son SUCCESS y 53 FAIL. Es lo que hay que mirar para saber si la llamada funcionó.

Opciones disponibles:
SUCCESS,
FAIL
message
object

Presente cuando la operación tiene algo que decir. Las lecturas simples responden sólo payload y status.