Referencia
- https://api.csfacturacion.com/descargasat-rest
API REST multipart/form-data
Credenciales de contratación vigente mediante Http Headers.
rfc-contratacion: RFC de contratación.
password-contratacion: Password de contratación.
Registrar Contribuyente
El siguiente endpoint es utilizado para dar servicio a una nueva empresa:
POST /descargasat-rest/empresas HTTP/1.1
Content-Type: multipart/form-data
Rfc-Contratacion: AAA010101AAA
Password-Contratacion: AAA010101AAA
Host: api.csfacturacion.com
Lista de parámetros requeridos en un multipart/form-data:
| Parametro | Tipo de dato | Descripción |
|---|---|---|
| rfc | string(13 ó 12) | RFC de la empresa, puede ser de 12 y 13 caracteres |
| razon_social | string | Razon Social de la empresa |
| key | file(.key) | Archivo .key FIEL |
| cert | file(.cert) | Archivo .cert FIEL |
| password | string | Contraseña FIEL |
| pfx | file(.pfx) | FIEL en formato PKCS12 |
Respuesta:
{
"status": true,
"response": "La empresa se guardó con éxito"
}
Solicitar Descarga
POST /descargasat-rest/consultas HTTP/1.1
Content-Type: multipart/form-data
Rfc-Contratacion: AAA010101AAA
Password-Contratacion: AAA010101AAA
Host: api.csfacturacion.com
Lista de parámetros requeridos en un multipart/form-data:
| Parametro | Tipo de dato | Descripción |
|---|---|---|
| rfc | string(13 ó 12) | RFC de la empresa, puede ser de 12 y 13 caracteres |
| fecha_inicial | Date (yyyy-mm-dd) o DateTime (yyyy-mm-dd hh:ii:ss) | Fecha de consulta inicial |
| fecha_final | Date (yyyy-mm-dd) o DateTime (yyyy-mm-dd hh:ii:ss) | Fecha de consulta final |
| tipo_solicitud | string(Metadata ó CFDI) | Tipo de solicitud para descargar facturas, puede ser Metadata ó CFDI |
| solicitar | string(Emitidas ó Recibidas) | Solicitar facturas Emitidas ó Recibidas |
Respuesta:
{
"status": true,
"response": {
"uuid": "e299e8f1-3b78-333c-8966-b097ffdfa1e2",
"msg": "La solicitud se ha puesto en cola con éxito"
}
}
Monitorear Estatus
GET /descargasat-rest/consultas/{UUID} HTTP/1.1
Rfc-Contratacion: AAA010101AAA
Password-Contratacion: AAA010101AAA
Host: api.csfacturacion.com
Parametros de respuesta
| Parametro | Tipo de dato | Descripción |
|---|---|---|
| status | bool | Estado de la petición actual, si trajo resultados con éxito |
| request_status | int | Estatus de la consulta representado por números: |
| - 1. Solicitud creada | ||
| - 2. En proceso | ||
| - 3. Terminada | ||
| - 4. Error | ||
| - 5. Descargando paquetes | ||
| total_cfdis | int | Numero de facturas encontradas en la consulta |
| response | string | Mensaje descriptivo del estatus actual |
Respuesta:
{
"status": true,
"request_status": 1,
"total_cfdis": null,
"response": "Solicitud creada"
}
Obtener Resultados
Este endpoint tiene 2 maneras de consultarlo, este para descargar un zip en base 64:
GET /consultas/descargas/{UUID}/base64 HTTP/1.1
Rfc-Contratacion: AAA010101AAA
Password-Contratacion: AAA010101AAA
Host: api.csfacturacion.com
Parametros de respuesta
| Parametro | Tipo de dato | Descripción |
|---|---|---|
| status | bool | Estado de la petición actual, si trajo resultados con éxito |
| response | string | Base64 del zip solicitado |
Respuesta:
{
"status": true,
"response": "UEsDBBQACAgAAOiiYk8tHbtQbXEBAG1xAQArAAAAQkVBMjJEMDAtQ....",
}
Y este para descargar un archivo zip directamente:
GET /consultas/descargas/{UUID}/ HTTP/1.1
Rfc-Contratacion: AAA010101AAA
Password-Contratacion: AAA010101AAA
Host: api.csfacturacion.com