Compartir a través de


BlueInk

El conector Blueink permite agregar la plataforma eSignature de Blueink a flujos de trabajo automatizados. El conector le permite comprobar el estado de la agrupación, crear nuevos conjuntos, obtener acceso a la información del firmante, etc.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con Blueink
URL https://help.blueink.com/en/
Correo Electrónico support@blueink.com
Metadatos del conector
Publicador Blueink
Sitio web https://blueink.com
Directiva de privacidad https://blueink.com/privacy-policy/
Categorías Gestión empresarial; Productividad

Con este conector versátil, los usuarios pueden integrar perfectamente la potente solución eSignature de Blueink en su flujo de trabajo aprovechando las funcionalidades de varios conectores de Power Automate. Esta integración permite a los usuarios automatizar la creación y distribución de paquetes de documentos sin esfuerzo. Al orquestar la interacción armónica de este conector con otros conectores, puede simplificar los procesos de administración de documentos, mejorar la eficiencia y garantizar una experiencia de firma de documentos perfecta y eficaz para sus clientes y partes interesadas. Ya sea automatizando aprobaciones de contratos, procesando documentos legales o administrando papeleos en cualquier otro contexto, este conector proporciona una herramienta eficaz para optimizar el flujo de trabajo y aumentar la productividad.

Prerrequisitos

Para usar este conector, necesitará una cuenta habilitada para api desde blueink.com.

Obtención de credenciales

Después de crear la cuenta, haga clic en el botón API situado en el lado izquierdo de la página. En Claves de API privadas, presione el botón Agregar clave de API . Asigne una etiqueta a la clave de API y presione Enviar. Copie la clave de API y guárdela en algún lugar, ya que no se volverá a mostrar.

Introducción al conector

Al crear una conexión blueink por primera vez, se le pedirá que escriba una clave de API. La clave de API siempre tendrá que empezar con token seguido de un espacio y, a continuación, la clave de API que creó. La entrada de la clave de API debe ser similar a esta clave> de API de token<.

Una acción popular es crear una agrupación. La creación de una agrupación requiere un conjunto complejo de entradas. Eche un vistazo a la documentación de la API en https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle para ver el aspecto de la variable body. Imagen siguiente como ejemplo de un cuerpo de creación de agrupación.

Untitled

Hay varias maneras de crear una agrupación y puede modificar este JSON para que se adapte a la agrupación que desea crear. Eche un vistazo a la API para obtener más formas de modificar este JSON. Esta usa una plantilla creada anteriormente que el usuario configuró en su cuenta.

Enumerar todas las agrupaciones completadas es otro punto de conexión popular. Agregue la acción Enumerar agrupaciones y, a continuación, cambie el botón de estado a co para los conjuntos completados. Puede mantenerse al día con todos los paquetes completados más recientes mediante este punto de conexión.

Untitled

Problemas y limitaciones conocidos

Se requiere un JSON de cuerpo para el punto de conexión de creación de agrupación.

Errores y soluciones comunes

Si recibe un error sobre una solicitud que no se realiza correctamente con un error de token no válido, asegúrese de que no acaba de pegar la clave de API en e incluir la cadena token anterior seguido de un espacio y, a continuación, la clave de API.

Si recibe un error sobre una entrada no válida al crear una agrupación, asegúrese de que es json válido que se envía a Blueink.

Preguntas más frecuentes

1. ¿Qué es Blueink?

  • Blueink es una solución avanzada de eSignature que simplifica el proceso de firma de documentos, lo que facilita el envío, firma y administración de documentos electrónicos de forma segura.

2. ¿Cuál es el conector de Microsoft para Blueink?

  • Microsoft Connector for Blueink es una herramienta que permite a los usuarios integrar la solución eSignature de Blueink sin problemas con Microsoft Power Automate, lo que permite la automatización y la administración mejorada de documentos.

3. ¿Cómo funciona Microsoft Connector for Blueink?

  • El conector permite crear flujos de trabajo automatizados mediante la combinación de Blueink con otros conectores de Power Automate. Puede automatizar la creación y distribución de agrupaciones de documentos, lo que mejora los procesos de administración de documentos.

4. ¿Cuáles son algunos casos de uso para Microsoft Connector for Blueink?

  • Entre los casos de uso comunes se incluyen la automatización de aprobaciones de contratos, la administración de documentos legales, la optimización de los procesos de papeleo y la garantía de una experiencia de firma de documentos fluida y eficaz para clientes y partes interesadas.

5. ¿Puedo usar Microsoft Connector for Blueink con otros productos de Microsoft?

  • Sí, el conector está diseñado para funcionar sin problemas con varios productos y servicios de Microsoft, lo que le permite integrar Blueink eSignatures en los flujos de trabajo centrados en Microsoft.

6. ¿Microsoft Connector for Blueink es fácil de configurar y usar?

  • Sí, es fácil de usar y está diseñado para ser sencillo. Puede configurar y personalizar los flujos de trabajo para satisfacer sus necesidades específicas de administración de documentos.

7. ¿Hay algún costo asociado al uso del conector de Microsoft para Blueink?

  • Los precios pueden variar en función de los contratos de uso y licencias. Es mejor comprobar con Blueink o Microsoft para obtener detalles de precios específicos.

8. ¿Puedo obtener soporte técnico para cualquier problema técnico con Microsoft Connector for Blueink?

  • Sí, Blueink y Microsoft suelen ofrecer recursos de soporte técnico y documentación para ayudar con cualquier problema técnico o pregunta que pueda tener con respecto al uso del conector.

9. ¿Microsoft Connector for Blueink es compatible con los servicios de Microsoft basados en Windows y en la nube?

  • Sí, el conector está diseñado para trabajar con servicios de Microsoft locales y basados en la nube, lo que proporciona flexibilidad en las opciones de integración.

10. ¿Dónde puedo encontrar más información sobre Microsoft Connector for Blueink?

  • Para obtener más información, incluidas las guías de configuración y la documentación, puede visitar el sitio web de Blueink o explorar la documentación de Microsoft Power Automate relacionada con este conector.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Clave de API blueink securestring La clave de LA API blueink. Esto se puede crear en Blueink en la pestaña API. El formato correcto es "Token XXXXXX", donde XXXXXX es la clave de API. Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualización de un webhook

Actualice el webhook con nuevos datos. TENGA en cuenta que las suscripciones que se omiten de esta solicitud se eliminarán. Si no desea reemplazar todos los datos en el webhook, es probable que quiera usar PATCH en su lugar.

Actualizar parcialmente un webhook

Actualice parcialmente el webhook con nuevos datos.

Actualizar parcialmente un WebhookExtraHeader

Actualice parcialmente WebhookExtraHeader con nuevos datos.

Actualizar parcialmente una persona

Actualice parcialmente la persona con nuevos datos.

Para agregar un nuevo correo electrónico o teléfono a la persona, incluya un contactChannel en la matriz "canales" sin un "id".

Para actualizar un contactChannel existente asociado a la persona, incluya un "id". Ese ContactChannel existente se actualizará con el nuevo correo electrónico o teléfono. Esto actualizará los paquetes activos asociados a la persona que se envía a ese correo electrónico (o teléfono).

Si un ContactChannel no incluye un "id", pero el correo electrónico (o teléfono) coincide con un ContactChannel existente, no se cambiará contactChannel.

Actualizar un paquete

Actualizar un paquete (también conocido como firmante) con un nuevo correo electrónico, número de teléfono, nombre o opciones de autenticación

El paquete actualizado debe seguir siendo entregable. Por ejemplo, si especifica un deliver_via valor de "phone", pero no se estableció ningún número de teléfono en el objeto PacketRequest original, esta solicitud también debe incluir o phone se devolverá un error.

Puede cambiar un paquete configurado originalmente para la firma incrustada (es decir, deliver_via se "insertó") para que se entregue por correo electrónico o SMS. Sin embargo, no se enviarán automáticamente notificaciones de firma ni recordatorios. Debe llamar a /packet/{packetId}/recordar/ para enviar un correo electrónico de notificación de firma (o SMS).

Si este firmante está asociado a una persona, la persona también se actualizará: se cambiará el nombre de la persona (si se proporciona) y se agregará cualquier nuevo correo electrónico o número de teléfono.

Actualizar un WebhookExtraHeader

Actualización de WebhookExtraHeader con nuevos datos

Actualizar una persona

Actualice la persona con nuevos datos. TENGA EN CUENTA que se eliminarán todos los canales de contacto que se omitan de esta solicitud. Si no desea reemplazar todos los datos de la persona, probablemente quiera usar PATCH en su lugar.

Agregar etiquetas a una agrupación

Agregue etiquetas adicionales a un paquete. No se quitan etiquetas existentes en la agrupación. El resultado de esta llamada es que Bundle.tags es la unión del conjunto de etiquetas anteriores con el conjunto de etiquetas nuevas. Se omiten las etiquetas duplicadas.

Cancelar un lote

Cancelar la agrupación especificada por el slug del lote

Creación de un lote

Creación y envío de una agrupación para la firma

Creación de un webhook

Creación de un nuevo webhook

Creación de un webhookExtraHeader

Creación de un nuevo encabezado de webhook

Crear una dirección URL de firma incrustada

Creación de una dirección URL que se puede usar para la firma insertada

Crear una persona

Cree una nueva persona. Una persona puede asociarse con un usuario de BlueInk o puede ser una persona independiente. Si desea crear una persona asociada a un usuario de BlueInk, debe proporcionar el user_id campo . Si desea crear una persona independiente, debe proporcionar el name campo .

Eliminar un webhook

Eliminación de un webhook por identificador

Eliminar un webhookExtraHeader

Eliminar un webhookExtraHeader

Eliminar una persona

Eliminar una persona. Esto también eliminará cualquier usuario de BlueInk asociado.

Enumerar agrupaciones

Devuelve una lista paginada de paquetes en su cuenta, ordenada por fecha de creación (de la más reciente a la más reciente). La paginación se puede controlar a través de paramatizadores de paginación (consulte Overview-Pagination>). Los filtros de cadena de consulta se pueden combinar, por ejemplo /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention, . Al combinar filtros, solo se devuelven los paquetes que coinciden con TODOS los filtros.

Enumerar eventos de agrupación

Obtener una lista de eventos asociados a la agrupación

Enumerar plantillas de documento

Enumerar todas las plantillas de documento

Enumerar webhookEvents

Enumeración de todos los eventos de webhook en la cuenta de BlueInk

Enumerar webhookEvents

Enumerar todas las webhookDeliveries en tu cuenta de BlueInk

Enumerar WebhookExtraHeaders

Enumerar todos los webhookExtraHeaders en tu cuenta de BlueInk

Enumerar webhooks

Enumerar todos los webhooks de la cuenta de BlueInk

Enviar un recordatorio

Enviar un correo electrónico o SMS de recordatorio a un firmante. Un aviso solo se puede enviar una vez cada hora. El aviso se enviará a través del método de entrega (correo electrónico o SMS) y a la dirección de correo electrónico (o número de teléfono) designado previamente para este paquete.

Lista de personas

Obtenga una lista de las personas de su cuenta. Opcionalmente, puede filtrar la lista proporcionando una consulta de búsqueda. Por ejemplo, para buscar todas las personas con el nombre "John", usaría la consulta search=John.

Obtención del secreto compartido de webhook

Obtención del secreto compartido de Webhook

Quitar etiquetas de un lote

Quitar etiquetas de un paquete. Si no existe una etiqueta en la solicitud en el paquete, se omite.

Recuperación de un webhook

Obtención de un webhook por identificador

Recuperar archivos de agrupación

Obtener archivos descargables para un paquete completado

Recuperar certificado de paquete de evidencia

Obtener un vínculo y una suma de comprobación del certificado de evidencia para este paquete

Recuperar datos de agrupación

Obtención de datos introducidos en campos para un paquete completado

Recuperar un lote

Recuperar un paquete por slug

Recuperar un WebhookExtraHeader

Recuperar los detalles de un WebhookExtraHeader

Recuperar una persona

Obtener una persona por identificador

Recuperar una plantilla de documento

Recuperar una plantilla de documento

Regeneración del secreto compartido de webhook

Regeneración del secreto compartido de Webhook

Actualización de un webhook

Actualice el webhook con nuevos datos. TENGA en cuenta que las suscripciones que se omiten de esta solicitud se eliminarán. Si no desea reemplazar todos los datos en el webhook, es probable que quiera usar PATCH en su lugar.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhookId True uuid

Identificador que identifica de forma única el webhook.

enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Devoluciones

Nombre Ruta de acceso Tipo Description
enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

extra_headers
extra_headers array of object
id
extra_headers.id uuid
nombre
extra_headers.name string

debe cumplir con RFC 7230

order
extra_headers.order integer
value
extra_headers.value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
extra_headers.webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Actualizar parcialmente un webhook

Actualice parcialmente el webhook con nuevos datos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhookId True uuid

Identificador que identifica de forma única el webhook.

enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Devoluciones

Nombre Ruta de acceso Tipo Description
enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

extra_headers
extra_headers array of object
id
extra_headers.id uuid
nombre
extra_headers.name string

debe cumplir con RFC 7230

order
extra_headers.order integer
value
extra_headers.value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
extra_headers.webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Actualizar parcialmente un WebhookExtraHeader

Actualice parcialmente WebhookExtraHeader con nuevos datos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de WebhookExtraHeader
webhookExtraHeaderId True uuid

Identificador que identifica de forma única el webhookExtraHeader.

id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Devoluciones

Nombre Ruta de acceso Tipo Description
id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Actualizar parcialmente una persona

Actualice parcialmente la persona con nuevos datos.

Para agregar un nuevo correo electrónico o teléfono a la persona, incluya un contactChannel en la matriz "canales" sin un "id".

Para actualizar un contactChannel existente asociado a la persona, incluya un "id". Ese ContactChannel existente se actualizará con el nuevo correo electrónico o teléfono. Esto actualizará los paquetes activos asociados a la persona que se envía a ese correo electrónico (o teléfono).

Si un ContactChannel no incluye un "id", pero el correo electrónico (o teléfono) coincide con un ContactChannel existente, no se cambiará contactChannel.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de persona
personId True uuid

Identificador que identifica de forma única a la persona

Correo electrónico
email email
id
id uuid
amable
kind string

em para correo electrónico. mp para teléfono.

phone
phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Devoluciones

Nombre Ruta de acceso Tipo Description
canales nueva
channels array of object
Correo electrónico
channels.email email
id
channels.id uuid
amable
channels.kind string

em para correo electrónico. mp para teléfono.

phone
channels.phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Actualizar un paquete

Actualizar un paquete (también conocido como firmante) con un nuevo correo electrónico, número de teléfono, nombre o opciones de autenticación

El paquete actualizado debe seguir siendo entregable. Por ejemplo, si especifica un deliver_via valor de "phone", pero no se estableció ningún número de teléfono en el objeto PacketRequest original, esta solicitud también debe incluir o phone se devolverá un error.

Puede cambiar un paquete configurado originalmente para la firma incrustada (es decir, deliver_via se "insertó") para que se entregue por correo electrónico o SMS. Sin embargo, no se enviarán automáticamente notificaciones de firma ni recordatorios. Debe llamar a /packet/{packetId}/recordar/ para enviar un correo electrónico de notificación de firma (o SMS).

Si este firmante está asociado a una persona, la persona también se actualizará: se cambiará el nombre de la persona (si se proporciona) y se agregará cualquier nuevo correo electrónico o número de teléfono.

Parámetros

Nombre Clave Requerido Tipo Description
Paquete slug
packetId True string

El slug que identifica de forma única el paquete.

body
body

Actualizar un WebhookExtraHeader

Actualización de WebhookExtraHeader con nuevos datos

Parámetros

Nombre Clave Requerido Tipo Description
Id. de WebhookExtraHeader
webhookExtraHeaderId True uuid

Identificador que identifica de forma única el webhookExtraHeader.

id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Devoluciones

Nombre Ruta de acceso Tipo Description
id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Actualizar una persona

Actualice la persona con nuevos datos. TENGA EN CUENTA que se eliminarán todos los canales de contacto que se omitan de esta solicitud. Si no desea reemplazar todos los datos de la persona, probablemente quiera usar PATCH en su lugar.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de persona
personId True uuid

Identificador que identifica de forma única a la persona

Correo electrónico
email email
id
id uuid
amable
kind string

em para correo electrónico. mp para teléfono.

phone
phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Devoluciones

Nombre Ruta de acceso Tipo Description
canales nueva
channels array of object
Correo electrónico
channels.email email
id
channels.id uuid
amable
channels.kind string

em para correo electrónico. mp para teléfono.

phone
channels.phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Agregar etiquetas a una agrupación

Agregue etiquetas adicionales a un paquete. No se quitan etiquetas existentes en la agrupación. El resultado de esta llamada es que Bundle.tags es la unión del conjunto de etiquetas anteriores con el conjunto de etiquetas nuevas. Se omiten las etiquetas duplicadas.

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

tags
tags array of string

Matriz de etiquetas

Cancelar un lote

Cancelar la agrupación especificada por el slug del lote

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

Creación de un lote

Creación y envío de una agrupación para la firma

Parámetros

Nombre Clave Requerido Tipo Description
body
body

Cuerpo JSON que define la agrupación que se va a crear.

Creación de un webhook

Creación de un nuevo webhook

Parámetros

Nombre Clave Requerido Tipo Description
enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Devoluciones

Nombre Ruta de acceso Tipo Description
enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

extra_headers
extra_headers array of object
id
extra_headers.id uuid
nombre
extra_headers.name string

debe cumplir con RFC 7230

order
extra_headers.order integer
value
extra_headers.value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
extra_headers.webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Creación de un webhookExtraHeader

Creación de un nuevo encabezado de webhook

Parámetros

Nombre Clave Requerido Tipo Description
id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Devoluciones

Nombre Ruta de acceso Tipo Description
id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Crear una dirección URL de firma incrustada

Creación de una dirección URL que se puede usar para la firma insertada

Parámetros

Nombre Clave Requerido Tipo Description
Paquete slug
packetId True string

El slug que identifica de forma única el paquete.

Devoluciones

Nombre Ruta de acceso Tipo Description
Expira
expires date-time

Marca de tiempo que indica cuándo expira la dirección URL

URL
url string

Dirección URL en la que se puede usar para la firma insertada

Crear una persona

Cree una nueva persona. Una persona puede asociarse con un usuario de BlueInk o puede ser una persona independiente. Si desea crear una persona asociada a un usuario de BlueInk, debe proporcionar el user_id campo . Si desea crear una persona independiente, debe proporcionar el name campo .

Parámetros

Nombre Clave Requerido Tipo Description
Correo electrónico
email email
id
id uuid
amable
kind string

em para correo electrónico. mp para teléfono.

phone
phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Devoluciones

Nombre Ruta de acceso Tipo Description
canales nueva
channels array of object
Correo electrónico
channels.email email
id
channels.id uuid
amable
channels.kind string

em para correo electrónico. mp para teléfono.

phone
channels.phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Eliminar un webhook

Eliminación de un webhook por identificador

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhookId True uuid

Identificador que identifica de forma única el webhook.

Eliminar un webhookExtraHeader

Eliminar un webhookExtraHeader

Parámetros

Nombre Clave Requerido Tipo Description
Id. de WebhookExtraHeader
webhookExtraHeaderId True uuid

Identificador que identifica de forma única el webhookExtraHeader.

Eliminar una persona

Eliminar una persona. Esto también eliminará cualquier usuario de BlueInk asociado.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de persona
personId True uuid

Identificador que identifica de forma única a la persona

Enumerar agrupaciones

Devuelve una lista paginada de paquetes en su cuenta, ordenada por fecha de creación (de la más reciente a la más reciente). La paginación se puede controlar a través de paramatizadores de paginación (consulte Overview-Pagination>). Los filtros de cadena de consulta se pueden combinar, por ejemplo /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention, . Al combinar filtros, solo se devuelven los paquetes que coinciden con TODOS los filtros.

Parámetros

Nombre Clave Requerido Tipo Description
Consulta de búsqueda
search string

Una consulta de búsqueda. Solo se devolverán agrupaciones que coincidan con la búsqueda. Se busca en los datos siguientes del paquete:

  • bundle slug
  • etiqueta de agrupación
  • custom_key de agrupación
  • nombre del firmante
  • correo electrónico del firmante
  • teléfonos de firmante

Por ejemplo /bundles/?search=foobar@example.com

Estado de agrupación
status string

Limite los conjuntos a los que tengan el estado especificado.

  • dr: Borrador: el paquete aún no se ha enviado
  • se: Enviado: el paquete se ha enviado, pero aún no lo han iniciado los firmantes.
  • st: Started : al menos un firmante ha empezado a revisar los documentos.
  • co: Completado: todos los firmantes han completado la revisión o firma
  • ca: Canceled - the Bundle was canceled
  • por ejemplo: Expirado: el paquete expiró antes de que se completara.
  • fa: Error: se produjo un error y no se pudo crear o completar la agrupación

Por ejemplo /bundles/?status=co

Lista de estado de agrupación
status__in string

Limite los paquetes a los que tengan uno de los estados especificados. Los estados deben estar separados por comas. Por ejemplo /bundles/?status=co,se,st

Etiqueta de agrupación
tag string

Devuelve paquetes que tienen la etiqueta especificada. Por ejemplo /bundles/?tag=some-tag

Lista de etiquetas de agrupación
tag__in string

Devuelve paquetes que tienen al menos una de las etiquetas especificadas. Las etiquetas deben estar separadas por comas. Por ejemplo /bundles/?tag=some-tag,another-tag

Criterio de ordenación de agrupación
ordering string

Controlar el criterio de ordenación de agrupaciones. Prefijo con "-" para invertir el criterio de ordenación. De forma predeterminada, los paquetes se ordenan por "creado", es decir, la fecha de creación de la agrupación de la mayoría a la menos reciente.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of

Enumerar eventos de agrupación

Obtener una lista de eventos asociados a la agrupación

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
descripción
description string

Una breve desripción del evento

amable
kind string

El tipo del evento como un código de 2 caracteres

packet_id
packet_id uuid

UUID de un paquete. Solo está presente si el evento está asociado a un paquete determinado.

marca de tiempo
timestamp date-time

Hora a la que se produjo el evento

Enumerar plantillas de documento

Enumerar todas las plantillas de documento

Devoluciones

Nombre Ruta de acceso Tipo Description
fields
fields array of

Matriz de campos colocados en el documento. Tenga en cuenta que los campos DocumentTemplate son ligeramente diferentes a los campos DocumentRequest, que tienen y default_valueeditor_roles en lugar de initial_value y editors.

file_url
file_url string

Dirección URL del archivo original que sirve como base para esta plantilla

is_shared
is_shared boolean

True si se comparte la plantilla de documento. False de lo contrario

nombre
name string

Nombre del documento. El valor predeterminado es el nombre de archivo o el documento cuando se cargó, pero se puede establecer en un nombre descriptivo para el usuario.

roles
roles array of object
key
roles.key string

Cadena única para este documento que identifica este rol

label
roles.label string

Una etiqueta fácil de usar para este rol

Enumerar webhookEvents

Enumeración de todos los eventos de webhook en la cuenta de BlueInk

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhook uuid

Solo se devolverá webhookEvents que coincidan con el identificador de webhook seleccionado.

Por ejemplo /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346

Tipo de evento
event_type string

Solo se devolverán webhookEvents con webhooks que coincidan con el event_type seleccionado o event_types.

Por ejemplo, por ejemplo, /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled

Estado
status integer

Solo se devolverán webhookEvents que coincidan con el estado seleccionado.

Por ejemplo, por ejemplo, /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2

Resultado correcto
success boolean

Solo se devolverán webhookEvents que coincidan con el estado correcto seleccionado.

Por ejemplo /webhooks/events/?success=true

Intervalo de fechas
date date-time

Solo se devolverán webhookEvents que se produzcan entre un intervalo de fechas. Nota: Las fechas se expresan como formato aaaa-MM-DD.

Por ejemplo /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
creado
created date-time
Entregas
deliveries array of object
Mensaje
deliveries.message string

un mensaje que describe los problemas

Pk
deliveries.pk uuid
estado
deliveries.status integer

mensaje de estado de la respuesta o 0 si no hay ningún estado

marca de tiempo
deliveries.timestamp date-time

cuando se produjo el intento de entrega (el inicio del intento, no cuando se produjo un error, por ejemplo, para un tiempo de espera).

event_type
event_type string
payload
payload string

la carga que se va a enviar a la entrega; json

Pk
pk uuid
estado
status integer

el código de estado de la última respuesta del punto de conexión de webhook. 0 indica que no se ha recibido ninguna respuesta

correcto
success boolean
webhook (punto de enlace web)
webhook uuid

UUID que identifica a qué webhook pertenece el evento

Enumerar webhookEvents

Enumerar todas las webhookDeliveries en tu cuenta de BlueInk

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhook uuid

Solo se devolverá webhookDeliveries que coincida con el identificador de webhook seleccionado.

Por ejemplo /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346

Id. de evento de webhook
webhook_event uuid

Solo se devolverá webhookDeliveries que coincida con el identificador de webhook_event seleccionado.

Por ejemplo /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346

Tipo de evento
event_type string

Solo se devolverán webhookDeliveries con webhooks que coincidan con el event_type seleccionado o event_types.

Por ejemplo, por ejemplo, /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled

Estado
status integer

Solo se devolverá webhookDeliveries que coincida con el estado seleccionado.

Por ejemplo, por ejemplo, /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2

Intervalo de fechas
date date-time

Solo se devolverá WebhookDeliveries que se produzca entre un intervalo de fechas. Nota: Las fechas se expresan como formato aaaa-MM-DD.

Por ejemplo /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
creado
created date-time
Entregas
deliveries array of object
Mensaje
deliveries.message string

un mensaje que describe los problemas

Pk
deliveries.pk uuid
estado
deliveries.status integer

mensaje de estado de la respuesta o 0 si no hay ningún estado

marca de tiempo
deliveries.timestamp date-time

cuando se produjo el intento de entrega (el inicio del intento, no cuando se produjo un error, por ejemplo, para un tiempo de espera).

event_type
event_type string
payload
payload string

la carga que se va a enviar a la entrega; json

Pk
pk uuid
estado
status integer

el código de estado de la última respuesta del punto de conexión de webhook. 0 indica que no se ha recibido ninguna respuesta

correcto
success boolean
webhook (punto de enlace web)
webhook uuid

UUID que identifica a qué webhook pertenece el evento

Enumerar WebhookExtraHeaders

Enumerar todos los webhookExtraHeaders en tu cuenta de BlueInk

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhook uuid

Solo se devolverán webhookExtraHeaders que coincidan con el identificador de webhook seleccionado.

Por ejemplo /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346

Tipo de evento
event_type string

Solo se devolverán webhookExtraHeaders con webhooks que coincidan con el event_type o event_types seleccionados.

Por ejemplo, por ejemplo, /webhooks/headers/?event_type=bundle_sent/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Enumerar webhooks

Enumerar todos los webhooks de la cuenta de BlueInk

Parámetros

Nombre Clave Requerido Tipo Description
Enabled
enabled boolean

Solo se devolverán webhooks que coincidan con el estado "habilitado" seleccionado.

Por ejemplo /webhooks/?enabled=true

Tipo de evento
event_type string

Solo se devolverán webhooks que coincidan con el event_type o event_types seleccionados.

Por ejemplo, por ejemplo, /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

extra_headers
extra_headers array of object
id
extra_headers.id uuid
nombre
extra_headers.name string

debe cumplir con RFC 7230

order
extra_headers.order integer
value
extra_headers.value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
extra_headers.webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Enviar un recordatorio

Enviar un correo electrónico o SMS de recordatorio a un firmante. Un aviso solo se puede enviar una vez cada hora. El aviso se enviará a través del método de entrega (correo electrónico o SMS) y a la dirección de correo electrónico (o número de teléfono) designado previamente para este paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Paquete slug
packetId True string

El slug que identifica de forma única el paquete.

Lista de personas

Obtenga una lista de las personas de su cuenta. Opcionalmente, puede filtrar la lista proporcionando una consulta de búsqueda. Por ejemplo, para buscar todas las personas con el nombre "John", usaría la consulta search=John.

Parámetros

Nombre Clave Requerido Tipo Description
Consulta de búsqueda
search string

Una consulta de búsqueda.

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
canales nueva
channels array of object
Correo electrónico
channels.email email
id
channels.id uuid
amable
channels.kind string

em para correo electrónico. mp para teléfono.

phone
channels.phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Obtención del secreto compartido de webhook

Obtención del secreto compartido de Webhook

Devoluciones

Nombre Ruta de acceso Tipo Description
create_date
create_date date-time
secret
secret b58

Quitar etiquetas de un lote

Quitar etiquetas de un paquete. Si no existe una etiqueta en la solicitud en el paquete, se omite.

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

tags
tags array of string

Matriz de etiquetas

Recuperación de un webhook

Obtención de un webhook por identificador

Parámetros

Nombre Clave Requerido Tipo Description
Id. de webhook
webhookId True uuid

Identificador que identifica de forma única el webhook.

Devoluciones

Nombre Ruta de acceso Tipo Description
enabled
enabled boolean
event_types
event_types array of string

tipos de eventos que desencadenarán el webhook

extra_headers
extra_headers array of object
id
extra_headers.id uuid
nombre
extra_headers.name string

debe cumplir con RFC 7230

order
extra_headers.order integer
value
extra_headers.value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
extra_headers.webhook uuid
id
id uuid
json
json boolean
URL
url url

debe ser la dirección URL completa, incluida http/https.

Recuperar archivos de agrupación

Obtener archivos descargables para un paquete completado

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
Expira
expires string

Hora a la que expira el vínculo, como hora con formato ISO 8601

file_url
file_url string

la dirección URL desde la que se puede descargar el archivo

Recuperar certificado de paquete de evidencia

Obtener un vínculo y una suma de comprobación del certificado de evidencia para este paquete

Parámetros

Nombre Clave Requerido Tipo Description
Paquete slug
packetId True string

El slug que identifica de forma única el paquete.

Recuperar datos de agrupación

Obtención de datos introducidos en campos para un paquete completado

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
attachments
attachments array of object

Matriz de datos adjuntos de archivo para un campo de datos adjuntos o null

Ext
attachments.ext string

Extensión de archivo

is_image
attachments.is_image boolean

True si este archivo adjunto es una imagen

nombre
attachments.name string

Nombre de archivo de los datos adjuntos

Num
attachments.num integer

El orden en el que se agregó el archivo, si hay varias cargas para un único campo de datos adjuntos (por ejemplo, una foto para cada página de un documento tomado con una cámara web)

size
attachments.size integer

Tamaño del archivo, en bytes

URL
attachments.url url

Dirección URL que se puede usar temporalmente para descargar el archivo adjunto

doc_key
doc_key string

Clave que identifica de forma única este documento en el paquete (desde el BundleRequest original)

field_key
field_key string

Clave que identifica de forma única el campo del documento (tal como se especifica en el DocumentRequestField original en DocumentRequest en BundleRequest o como configurado en DocumentTemplate).

filled_by
filled_by string

Clave de paquete del firmante que escribió el valor de este campo. Si el valor del campo era una "initial_value" no editada por un firmante, el valor es "initial". Si el valor de campo era el valor predeterminado configurado en documentTemplate, el relleno es "predeterminado".

amable
kind string

El tipo de campo

label
label string

Etiqueta del campo (posiblemente en blanco)

packet_id
packet_id

Identificador de paquete del firmante que especificó el valor de este campo, o null si un firmante no ha rellenado el valor del campo (es decir, era un valor de initial_value o defaul).

value
value

El valor del campo .

Recuperar un lote

Recuperar un paquete por slug

Parámetros

Nombre Clave Requerido Tipo Description
Bundle Slug
bundleSlug True string

El slug que identifica de forma única el lote

Recuperar un WebhookExtraHeader

Recuperar los detalles de un WebhookExtraHeader

Parámetros

Nombre Clave Requerido Tipo Description
Id. de WebhookExtraHeader
webhookExtraHeaderId True uuid

Identificador que identifica de forma única el webhookExtraHeader.

Devoluciones

Nombre Ruta de acceso Tipo Description
id
id uuid
nombre
name string

debe cumplir con RFC 7230

order
order integer
value
value string

debe cumplir con RFC 7230

webhook (punto de enlace web)
webhook uuid

Recuperar una persona

Obtener una persona por identificador

Parámetros

Nombre Clave Requerido Tipo Description
Id. de persona
personId True uuid

Identificador que identifica de forma única a la persona

Devoluciones

Nombre Ruta de acceso Tipo Description
canales nueva
channels array of object
Correo electrónico
channels.email email
id
channels.id uuid
amable
channels.kind string

em para correo electrónico. mp para teléfono.

phone
channels.phone phone
id
id uuid
is_user
is_user boolean

True si esta persona está asociada a un usuario de BlueInk

metadata
metadata object

Metadatos que se van a asociar a esta persona. Los metadatos se pueden usar en SmartFill para rellenar automáticamente los documentos. Consulte la documentación de SmartFill para obtener más información.

nombre
name string

Nombre de la persona

Recuperar una plantilla de documento

Recuperar una plantilla de documento

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de plantilla
templateId True uuid

Identificador que identifica de forma única la plantilla.

Devoluciones

Nombre Ruta de acceso Tipo Description
fields
fields array of

Matriz de campos colocados en el documento. Tenga en cuenta que los campos DocumentTemplate son ligeramente diferentes a los campos DocumentRequest, que tienen y default_valueeditor_roles en lugar de initial_value y editors.

file_url
file_url string

Dirección URL del archivo original que sirve como base para esta plantilla

is_shared
is_shared boolean

True si se comparte la plantilla de documento. False de lo contrario

nombre
name string

Nombre del documento. El valor predeterminado es el nombre de archivo o el documento cuando se cargó, pero se puede establecer en un nombre descriptivo para el usuario.

roles
roles array of object
key
roles.key string

Cadena única para este documento que identifica este rol

label
roles.label string

Una etiqueta fácil de usar para este rol

Regeneración del secreto compartido de webhook

Regeneración del secreto compartido de Webhook

Devoluciones

Nombre Ruta de acceso Tipo Description
create_date
create_date date-time
secret
secret b58