Fundamentos

Cabeceras HTTP

Esta página resume las cabeceras HTTP que la API requiere, las que recomienda enviar, y las que devuelve en cada respuesta.

Cabeceras que debes enviar

Obligatorias

HeaderValorCuándo
X-API-KeyTu API KeySiempre

Recomendadas

HeaderValor sugeridoPor qué
Acceptapplication/jsonGarantiza que los errores se serialicen como JSON.
Content-Typeapplication/jsonNecesario para POST, PUT y PATCH con cuerpo JSON.
Content-Typemultipart/form-dataSolo al subir archivos (firma electrónica .p12 o logotipo del negocio).
User-AgentMiSistema/1.0 (+contacto@miempresa.com)Facilita el soporte y la trazabilidad de incidencias.

Cabeceras que devuelve la API

HeaderCuándoSignificado
Content-Type: application/jsonRespuestas exitosas en JSONEl cuerpo es parseable como JSON.
Content-Type: application/problem+jsonRespuestas de error con detalle por campoCuerpo con la estructura RFC 7807. Ver Errores.
Content-Type: application/pdfGET /documents/{id}/download?format=pdfEl cuerpo es el binario del PDF.
Content-Type: application/xmlGET /documents/{id}/download?format=xmlEl cuerpo es el XML autorizado por el SRI.
Content-DispositionDescargasIndica el nombre sugerido del archivo.
X-RateLimit-LimitTodas las respuestasCupo total de solicitudes en la ventana actual.
X-RateLimit-RemainingTodas las respuestasCupo restante en la ventana actual.
Retry-AfterSolo en respuestas 429Segundos a esperar antes de reintentar.