Iniciar sesión

Endpoint: POST /login/

🚧 Usuarios de Sandbox:

A continuación listamos la cuenta definida para el ambiente de sandbox

RFCPassword
100000000000sandbox_password

¿Para qué sirve?

Al iniciar la operativa con nuestra API del SAT, lo primero que debes hacer es iniciar sesión a la Entidad con las credenciales del usuario final.

Parámetros requeridos

PARÁMETROSDESCRIPCIÓN
provider Proveedor: sat
rfc Número de RFC.
password Contraseña de acceso.
scope Tipo de login a realizar.

Opciones:
· cfdi -> para descargar facturas
· siat -> para consultar "Opinión de cumplimiento"

Posibles respuestas

📘

Demoras en inicio de sesión

Iniciar sesión puede demorar hasta 20s en generar una respuesta. Esto depende puramente de la carga que tenga la página de la Hacienda.

Respuesta exitosa

STATUSDESCRIPCIÓN
status - logged_in -> sesión iniciada correctamente.
session_key Clave de autenticación que deberá ser usada en todas las requests siguientes.

Respuesta errónea

ParámetrosDescripción
status- wrong_credentials -> usuario o password inválidos.

- missing_credentials -> falta un campo de credenciales.
message
(opcional)
Mensaje obtenido en caso de que las credenciales sean erróneas.
missing_fields
(opcional)
Campos faltantes para la consulta.

Ejemplos

Iniciar sesión

POST /login/ HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

provider=sat&rfc=RFC&password=PASSWORD&scope=cfdi
curl -X POST "https://fiscal.sandbox.prometeoapi.com/login/" -d "provider=sat&rfc=RFC&password=PASSWORD&scope=cfdi" -H "X-API-Key: <API KEY>"
import requests

requests.post('https://fiscal.sandbox.prometeoapi.com/login/', data={
    'provider': 'sat',
    'rfc': 'RFC',
    'password': 'PASSWORD',
    'scope': 'cfdi',
}, headers={
    'X-API-Key': '<API KEY>'
})
var request = require('request');

request.post({
  "url": "https://fiscal.sandbox.prometeoapi.com/login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "form": {
    "provider": "sat",
    "rfc": "RFC",
    "password": "PASSWORD",
    "scope": "cfdi"
  }
});

Respuesta exitosa

{
    "status" : "logged_in",
    "session_key" : "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
}

Respuesta con interacción requerida

{
    "context": "/captcha/a9bff7e2ff97582c69aa00a785c3e191.jpg",
    "field": "captcha",
    "session_key": "ce11f66e-ed28-4a4c-acc7-bb28bb899c75",
    "status": "interaction_required"
}

Respuesta errónea

{
    "status" : "wrong_credentials",
    "message" : "El RFC o contraseña son incorrectos. Verifique su información e inténtelo de nuevo."
}

Respuesta errónea por falta de parámetros

{
    "status" : "missing_credentials",
    "missing_fields" : [
        "password"
    ]
}

Respuesta errónea por falta de API key

{
    "data": null,
    "error": "Missing API key"
}