Descargar Formatos de Documentos Recibidos

Descargar Formatos de Documentos Recibidos#

Este servicio permite descargar los diferentes formatos asociados a los documentos recibidos, tales como:

  • PDF

  • UBL-XML

  • AttachedDocument

  • DTO

Para realizar el consumo de la API, es necesario definir previamente el entorno de trabajo en el que se ejecutará la solicitud.

SOVOS Saphety dispone de dos ambientes (Pruebas y Producción), los cuales se encuentran detallados en el apartado de Entornos.

Consumo del método para descargar formato PDF.#

descargarPDF-RE

El Verbo Http (acción) que se utiliza para la consulta de este formato es:

GET

El método que se utiliza para la consulta de este formato es:

    /v2/{virtualOperator}/inbounddocuments/{DocumentId}/pdf

Para esta petición se requiere como parámetro el alias de su operador virtual y el codigo de la compañia companyId.

Parametro virtualOperator

Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.

Parametro DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el codigo identificador unico del documento recibido.

Respuesta#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "Id": "a395ec28-cca8-ed11-a2d6-00505695a8eb",
        "FileName": "document.pdf",
        "DocumentFormat": "PDF",
        "Content": "PDF codificado en base64",
        "ZipFileName": null
    },
    "ResultCode": 200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "cufe",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "88f71533-0a2a-"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Note

Una vez recibida la respuesta con el PDF codificado en base64, se podrá proceder a convertirlo al formato PDF.

Consumo del método para descargar formato UBL - XML.#

descargarUBL

El Verbo Http (acción) que se utiliza para la consulta de este formato es:

GET

El método que se utiliza para la consulta de este formato es:

    /v2/{virtualOperator}/inbounddocuments/{DocumentId}/ubl

Para esta petición se requiere como parámetro el alias de su operador virtual y el codigo de la compañia companyId.

Parametro virtualOperator

Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.

Parametro DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el codigo identificador unico del documento recibido.

### Respuesta del Servicio#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "Id": "a195ec28-cca8-ed11-a2d6-00505695a8eb",
        "FileName": "SETP990053146.xml",
        "DocumentFormat": "XML",
        "Content": "UBL codificado en base64",
        "ZipFileName": null
    },
    "ResultCode": 200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "cufe",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "88f71533-0a2a-"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Note

Una vez recibida la respuesta con el PDF codificado en Base64, se podrá realizar la conversión o decodificación del archivo para obtener el documento en formato PDF legible.

Consumo del método para descargar formato AttachedDocument.#

descargarAD

El Verbo Http (acción) que se utiliza para la consulta de este formato es:

GET

El método que se utiliza para la consulta de este formato es:

    /v2/{virtualOperator}/inbounddocuments/{DocumentId}/attacheddocument

Para esta petición se requiere como parámetro el alias de su operador virtual y el codigo de la compañia companyId.

Parametro virtualOperator

Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.

Parametro DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el codigo identificador unico del documento recibido.

Respuesta del Servicio#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "Id": "a295ec28-cca8-ed11-a2d6-00505695a8eb",
        "FileName": "document.xml",
        "DocumentFormat": "ATTACHED_DOCUMENT",
        "Content": "AttachedDocument codificado en base64",
        "ZipFileName": null
    },
    "ResultCode": 200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "cufe",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "88f71533-0a2a-"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Note

Una vez recibida la respuesta con el XML - UBL codificado en Base64, se podrá realizar la conversión para obtener el archivo en formato XML legible.

Consumo del método para descargar formato Attachments.#

descargarAttachment

El Verbo Http (acción) que se utiliza para la consulta de este formato es:

GET

El método que se utiliza para la consulta de este formato es:

    /v2/{virtualOperator}/inbounddocuments/{DocumentId}/attachments

Para esta petición se requiere como parámetro el alias de su operador virtual y el codigo de la compañia companyId.

Parametro virtualOperator

Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.

Parametro DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el codigo identificador unico del documento recibido.

Respuesta del Servicio#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": [
        {
            "Id": "a495ec28-cca8-ed11-a2d6-00505695a8eb",
            "Filename": "saphety/public/outbounddocuments/214e09025afe1229f636815f819325da93e19f7e1ea53b4ba719a383700e9cd23d646e1c68455ae10b7e5c740c3f00b62fe8c4ea5e36c08f/attachments/zip",
            "ContentType": "text/uri-list",
            "ContentLength": 161,
            "Content": null
        }
    ],
    "ResultCode": 200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "cufe",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "88f71533-0a2a-"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Note

Una vez recibida la respuesta con el Attachment codificado en Base64, se podrá realizar la conversión para obtener el archivo en formatos correctamente legible.

Referencia: Swagger#

Para obtener más información, puedes consultar la documentación del API de SOVOS Saphety en Swagger. A continuación, se indican los enlaces según el ambiente: