Clarisa ofrece una avanzada API, diseñada para una integración sencilla, que le permitirá conectar su sistema y agilizar diversas operaciones.
Este servicio describe la funcionalidad de la API para descarga de XML en Documento equivalente electrónico Servicios Públicos Domiciliarios, Nota de ajuste crédito SPD, Nota de ajuste débito SPD que correspondan a su NIT .
Antes de continuar:
Para utilizar cualquier servicio de la API, es importante contar con un token de autenticación y autorización. Si necesita asistencia para obtenerlo, consulte la documentación detallada que se indica en el siguiente link.
https://ayuda.clarisa.co/guia-para-consumir-api-de-login/
Importante !
Para la descarga masiva de documentos electrónicos , es decir mas de un documento, se debe enviar cada petición con intervalo de 5 segundos como mínimo para evitar el cruce de peticiones.
Descarga XML en Base 64
CABECERAS:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO: "GET"
Parametros de URL (QueryParam):
| LLAVE | VALOR | DESCRIPCIÓN |
| nit | 12345 | Corresponde al Nit de la empresa donde se realizó el documento |
| tipoDocumento | 1 | Corresponde al Tipo de documento electrónico que se desea consultar. |
| numeroDocumento | SPD1 | Corresponde a el Número del documento , que se desea consultar. |
Ejemplo:
https://pru.clarisacloud.com:8443/api/equivalente/rest/v1/de/spd/xml/?nit=1051067571&tipoDocumento=1&numeroDocumento=SPD21
Petición:
| Tipo de Documento | Codigo |
|---|---|
| Documento Equivalente Servicios Públicos Domiciliarios | 1 |
| Nota de Ajuste Crédito SPD | 2 |
| Nota de Ajuste Débito SPD | 3 |
Respuesta:
| Nombre | Tipo dato | Descripción |
|---|---|---|
| data | Alfanumérico | Contiene el archivo en base 64 |
| lastAction | Alfanumérico | Nombre de la acción bajo la cual responde la petición |
| success | Booleano | Determina si la operación fué exitosa o no |
| textResponse | Alfanumérico | Texto de la respuesta |
| titleResponse | Alfanumérico | Título de la respuesta |
| errores | Alfanumérico | Contiene los errores o validaciones cuando la búsqueda no fue exitosa |
Respuesta TOKEN
Tiene una vigencia de 12 horas, por favor
recuerde utilizar el token asignado en el login, para poder acceder a la API de documento electrónico.
Correct
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Incorrecto
Si la solicitud no es correcta, recibirá la siguiente respuesta:
CÓDIGO HTTP: 400 | 401 | 500
Estamos comprometidos en brindarle una experiencia eficiente y segura en la gestión de sus documentos electrónicos.