SubalansAPI
InicioObtener API key
Referencia

Resumen de códigos

HTTPCuerpoAcción del cliente
200{ ok: true, ... }Procesar.
400{ ok: false, error }Corregir la petición.
401{ error }Revisar token.
422{ ok: false, code, error }Pedir al usuario corregir credencial.
429{ error, plan, rate_per_min } + retry-afterEsperar y reintentar, o subir de plan.
502 / 504{ ok: false, code: "tecnico"/"timeout", error }Reintentar con backoff.
Referencia

Health checks

La API expone GET /api/v1/health (sin autenticación) para monitoreo. Devuelve el estado de cada servicio.

GET /api/v1/health
{ "ok": true, "services": { "constancia": true, "opinion": true, "opinion-imss": true, "infonavit": true, "buzon": true, "cfdi": true, "efos": true } }
Referencia

Buenas prácticas

  • Llama desde tu backend. Nunca expongas el token ni credenciales en el cliente.
  • Distingue 4xx de 5xx. 4xx = el usuario debe actuar (no reintentar igual); 5xx = el portal del gobierno falló (reintentar con backoff).
  • Muestra el campo error tal cual. Ya viene en español y es accionable.
  • Valida la e.firma antes de pedirla. La API rechaza credenciales mal formadas en milisegundos: aprovéchalo para dar feedback inmediato.
  • No abras documentos del Buzón. La API entrega metadatos a propósito; abrir el documento genera un acuse legal de notificación.
  • Timeouts generosos (≥180 s) para IMSS e Infonavit.
  • EFOS para validación masiva de proveedores: es instantáneo y no consume credenciales.
← Endpoints