Adjuntar Documentos a una Venta

Este método permite adjuntar documentos a una venta, como certificados de discapacidad, familia numerosa o monoparental.

1. Método de Acceso

Parámetro

Descripción

URL

{baseurl}/api/transaction

Verbo HTTP

PUT

Content-Type

multipart/form-data

⚠️ Importante:

  • El envío de documentos debe hacerse en formato multipart/form-data.
  • Se pueden adjuntar varios archivos en la misma solicitud.
  • Cada archivo se enviará en un campo llamado Attachments.

 

2. Datos de Envío

Campo

Descripción

ApiKey

Clave única y privada del colaborador.

SaleId

Identificador de la venta a la que se adjuntarán los documentos.

Attachments

Archivos adjuntos enviados en formato multipart/form-data.

api-version

Parámetro opcional para indicar la versión del API (por defecto 3.21).

 

3. Ejemplo de Petición multipart/form-data

PUT {baseurl}/api/transaction

Content-Type: multipart/form-data; boundary="----MyGreatBoundary"

 

------MyGreatBoundary

Content-Type: text/plain; charset=utf-8

Content-Disposition: form-data; name=ApiKey

 

{apiKey}

 

------MyGreatBoundary

Content-Type: text/plain; charset=utf-8

Content-Disposition: form-data; name=SaleId

 

5005558512577665890

 

------MyGreatBoundary

Content-Type: application/pdf

Content-Disposition: form-data; name=Attachments; filename="documentation.pdf"; filename*=utf-8''documentation.pdf

 

[Array de bytes para documentation.pdf]

 

------MyGreatBoundary

Content-Type: application/pdf

Content-Disposition: form-data; name=Attachments; filename="documentation2.pdf"; filename*=utf-8''documentation2.pdf

 

[Array de bytes para documentation2.pdf]

 

4. Estructura de la Respuesta

Si la petición es exitosa, el API devolverá:

Campo

Descripción

Success

true si los documentos se adjuntaron correctamente, false en caso contrario.

Timestamp

Fecha y hora de la respuesta.

ErrorMessage

Mensaje de error en caso de que ocurra un problema.

ErrorCodes

Array con códigos de error si la solicitud falla.

ErrorEntityBreakDown

Lista con identificadores y nombres de los errores detectados.

 

5. Ejemplo de Respuesta Exitosa

{

    "Success": true,

    "ErrorMessage": "",

    "Timestamp": "2023-01-25T10:46:39.532802",

    "ErrorEntityBreakDown": []

}

6. Ejemplo de Respuesta con Error

{

    "Success": false,

    "ErrorMessage": "El archivo excede el tamaño permitido.",

    "Timestamp": "2025-02-05T12:45:00.000Z",

    "ErrorCodes": [104],

    "ErrorEntityBreakDown": [

        {

            "Id": "5005558512577665890",

            "Name": "File Size Limit Exceeded"

        }

    ]

}

7. Consideraciones Finales

  • La ApiKey debe mantenerse en secreto y solo debe usarse en el servidor.
  • Los archivos adjuntos deben ser en formatos permitidos (PDF, imágenes, etc.).
  • Si Success = false, revisar ErrorMessageErrorCodes para entender la causa del error.
  • Los archivos pueden usarse como justificantes para descuentos o accesos especiales en Experticket.

¿Te ha parecido útil este artículo?