Guía Técnica Para Consumo API Descarga PDF Documento Soporte

Por /

Clarisa ofrece una API que le permite a su sistema integrarse y descargar el PDF de un Documento Soporte que ya se haya creado.

La acción disponible para la API de Descarga PDF del Documento Soporte, solo podrá traer Documentos que correspondan a su NIT y que ya estén creados.

Documento electrónico

CABECERAS:

CABECERASVALOR
Content-Typeapplication/json
Authorizationtoken de usuario

METODO: "GET"

Parámetros de URL:

LLAVEVALORDESCRIPCIÓN
nit123123124Corresponde al Nit de la empresa donde se realizó el Documento Soporte.
numeroDocSoporteDS10Corresponde a el número de Documento Soporte, que desea descargar en formato PDF

Ejemplo:

https://pru.clarisacloud.com:8443/reporte/rest/api/v1/pdf/docSoporte?nit=123123124&numeroDocSoporte=DS10



Respuesta:


Nombre Tipo dato Descripción
data Alfanumérico Contiene el archivo PDF en base64
lastAction Alfanumérico Nombre de la acción bajo la cual se indica la respuesta
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

Recuerde utilizar el token asignado en el login, para poder acceder a la API de Documento Soporte. Tiene una vigencia de 24 horas

Correcto

En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:

CÓDIGO HTTP: 200

{
  • "data": "JVBERi0xLjUKJeLjz9MKNyAwIG9iago8PC9Db2xQACgAoAKACgAoAKACgAKACgAoAKACgAoAKDU1OTA1Pj5zdHJlYW02wBDAQMDAwQDBAgEBAgQCwkLEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBABQADAREAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/ACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAK",
  • "lastAction": "Generar PDF para documento soporte",
  • "success": true,
  • "textResponse": "PDF generado exitosamente",
  • "titleResponse": "SUCCESS"
...}// 5 items

Incorrecto

Si la solicitud no es correcta, recibirá la siguiente respuesta:

CÓDIGO HTTP: 400 | 401 | 500

{
  • "errores": {
    • "errores": [
      • {
        • "codError": "",
        • "errorMessage": "El documento soporte consultado no existe"
        ...}// 2 items
      ...]// 1 item      ,
    • "totalErrores": 1
    ...}// 2 items    ,
  • "lastAction": "Generar PDF para documento soporte",
  • "success": false,
  • "textResponse": "Error al generar PDF para el documento soporte",
  • "titleResponse": "FAILED"
...}// 5 items

Los comentarios están cerrados.