Crear un contenedor

Para crear un contenedor, deberás realizar una petición al siguiente endpoint:

Método: POST http://api.digitafirma.com/v1/containers

Request Body

A continuación se describen los parámetros esperados en el cuerpo de la petición:

Atributos principales

Atributo	Tipo	Descripción
name	string	Nombre que se asignará al contenedor.
description	string	Descripción sobre el contenedor.
logo	string	Imagen codificada en base64 para el logotipo de la empresa.
status	string	Enum: “ON_HOLD” “CLOSED” “SIGNING” “SIGNED” “PARTIAL_SIGNED” “REJECTED” “ERROR”Status del contenedor. Por defecto es: ” ON_HOLD “
tries	integer	Intentos de notificación que el sistema ejecutará.
remember_every	integer	Intervalo de frecuencia para el envío de recordatorios.
remember_at	string	Hora en la que el sistema lanzará la notificación.
sign_mode	string	Enum: “CLASSIC” “PDF_SIGNATURE” “CLASSIC_BATCH” Modo de firmado que el sistema usará para firmar el documento
sign_position	string	Enum: “UPPER_RIGHT” “UPPER_LEFT” “LOWER_RIGHT” “LOWER_LEFT” “NONE” Posición de las firmas en la última hoja del documento. Si el modo de firmado es CLASSIC, este parámetro debe ser NONE.
webhook	string	URL externa que recibirá eventos o actualizaciones sobre el estado del contenedor.
mode_logo	string	Enum: “FULL_BRANDING” “MEDIUM_BRANDING” “NO_BRANDING” “NO_SIGNATURE_SHEET” Modo en el que se presentará el logo de DigitaFirma en el documento firmado
sign_ordered	string	Enum: “ACTIVE” “INACTIVE” Activa la firma ordenada del documento en el orden del array de firmantes dado.
notification_mode	string	Configura el envío automático de notificaciones. Ejemplo: ENABLED, DISABLED.
signatures	array	Lista de objetos con la información de los firmantes.
spectators	array	Lista de objetos con la información de los espectadores.

Objeto signatures

Cada elemento del arreglo signatures debe incluir la siguiente información:

Atributo	Tipo	Descripción
name	string	Nombre completo del firmante.
email	string	Correo electrónico del firmante donde recibirá la url de acceso para firmar.
phone	string	Número de teléfono celular del firmante (incluir código de país) para notificar via whatsapp.
rfc	string	RFC Para filtrar por RFC, util al usar E.FIRMA.

Objeto spectators

Cada elemento del arreglo spectators debe incluir la siguiente información:

Atributo	Tipo	Descripción
name	string	Nombre completo del espectador.
email	string	Correo electrónico del espectador para recibir notificaciones y acceso de lectura.

Ejemplo de Integración

{
  "name": "string",
  "description": "string",
  "logo": "string",
  "status": "ON_HOLD",
  "tries": 0,
  "remember_every": 0,
  "remember_at": "string",
  "sign_mode": "CLASSIC",
  "sign_position": "UPPER_RIGHT",
  "webhook": "string",
  "mode_logo": "FULL_BRANDING",
  "sign_ordered": "ACTIVE",
  "notification_mode": "ENABLED",
  "signatures": [
    {
      "name": "string",
      "email": "string",
      "phone": "string",
      "rfc": "string"
    }
  ],
  "spectators": [
    {
      "name": "string",
      "email": "string"
    }
  ]
}