Método para descargar el PDF (DownloadDocumentPdf)
Este método permite descargar el archivo PDF de un documento utilizando el servicio GET DownloadDocumentPdf.
Por medio de este método, se obtiene el archivo PDF codificado en base 64 del documento consultado.
Para conectarse a esta funcionalidad será necesario que ingrese la URL de acuerdo con el ambiente a consumir:
PRODUCCIÓN
https://developers.gosocket.net/api/v1/File/DownloadDocumentPdfSANDBOX
https://developers-sbx.gosocket.net/api/v1/File/DownloadDocumentPdf¿Cómo funciona el método DownloadDocumentPdf?
Para realizar la petición, el método tiene los siguientes parámetros:
| DownloadDocumentPdf (request) | |||
|---|---|---|---|
| Parámetro | Tipo | Descripción | Valores permitidos |
| globalDocumentId* | String | Identificación de documento en Gosocket. | UUID de 36 caracteres alfanuméricos xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| Type* | String | Tipo de pdf a descargar. En la respuesta se mostrará el tipo definido | default: descarga el pdf del documento. |
*Requerido
Ejemplo de petición
Al ser un método GET, utilizamos la pestaña Params en Postman para formar el query.
- Seleccione el tipo de método. En este caso, se debe seleccionar GET.
- Ingrese la URL del método.
- Ingrese los parámetros que se muestran en la tabla anterior con sus valores correspondientes.
- Presione Send.
Ejemplo de respuesta
Una vez decodificada la respuesta en base 64, se mostrará la representación gráfica del documento.
Carcaterísticas del método
- Cuando no existe el Id del documento (globalDocumentId), el sistema responde un mensaje de error:
- Se puede descargar el archivo tantas veces como se requiera.
- Al momento de decodificar el archivo descargado se debe tener en cuenta que el archivo PDF viene con codificación sencilla, por lo tanto, sólo es necesario decodificarlo una vez para poder ver el PDF.