viafirma inbox :: manual de integración

Añadir un anexo

Método para añadir un anexo a una petición.

  • Tipo: POST
  • URL: url-inbox/api/v3/requests/{publicAccessId}/annexes
  • Tipo de entrada: application/json
  • Tipo de salida: application/json
  • Parámetros:
    • publicAccessId: código público de la petición.

Json de entrada

El json de entrada está compuesto por los siguientes campos:

  • userCode: Código del usuario. En caso de no indicarse se tomará el del usuario web service.
  • document: Documento. Los documentos pueden venir dados de 3 formas distintas, dependiendo de cual se emplee se deberán indicar unos campos u otros.

    Para documentos generados a partir de plantillas existentes en viafirma inbox debe rellenar el campo template que está compuesto por los campos:

    • code: Código de la plantilla.
    • vars: Lista de variables para crear la plantilla. Para cada variable se indicas los campos:
      • key
      • value

    Para documentos en base 64 se deben indicar los siguientes campos:

    • filename: Nombre del documento.
    • base64: Contenido del documento en base64.

    Para documentos disponibles en una url externa se deben indicar los siguientes campos:

    • filename: Nombre del documento.
    • url: Url para la descarga del documento.

Ejemplo de json de entrada

Json de salida

El json de salida está compuesto por los siguientes campos:

  • filename: Nombre del fichero.
  • publicAccessId: Código público del documento.

Ejemplo de json de salida