Cargar documentos y enviarlos para su firma: API Admissão Digital

EL Admissão Digital Tiene API que le permiten cargar documentos y enviarlos a los candidatos para que los firmen electrónicamente .

Primero, debe autenticarse en la Plataforma Senior X para obtener el token de acceso que le permitirá realizar solicitudes. Luego, el proceso se realiza en tres pasos:

1. POST requestUploadDocumentSign : solicita la URL para cargar archivos de documentos. La API envía la solicitud de carga y devuelve la URL donde se almacenarán los archivos.
2. PUT <uploadUrl> : carga los documentos a la URL obtenida en el paso anterior. La API carga los archivos y devuelve si la carga se realizó correctamente.
3. POST documentosEnviar : envía los documentos para la firma del candidato y devuelve si el envío fue exitoso.

Pasos para implementar la integración:

Documentación de referencia:

• Autenticación (plataforma Senior X)
• Solicitar cargar documento firmar (POST)
• solicitarSubirDocumentoFirmar (PUT)
• enviar documentos (POST)

1) solicitarSubirDocumentoFirmar (POST)

Envíe la solicitud de carga y devuelva la URL donde se deben cargar los archivos.

Definiciones de API:

• URL
• Encabezamiento
• Parámetros
• Ejemplo
• Respuestas

URL

POST <url_plataforma> /t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/actions/ requestUploadDocumentSign

Reemplace <url_plataforma> con la URL correspondiente a su entorno. Si es el entorno de producción, reemplácelo por: https://platform.senior.com.br

Encabezamiento

Reemplace <access_token> con la clave de acceso obtenida de la API de autenticación de la plataforma .

Parámetros

* Obligatorio

Ejemplo

  { "fileName": "contrato-de-admisión.pdf" }

Respuestas

Respuesta de ejemplo (200):

{ "fileUrl": "GED:\\upload\\1.0\\{\"id\":\"872f39ed-bfca-4878-9bc8-b33c9214dd15\",\"fileName\":\"contrato-de-admisión .pdf \",\"version\":\"version-e9af8a56-4dc8-4446-98ec-91a765a45eef\"}", "uploadUrl": "https://url-cloud-storage/usuario/contrato-de-admision. pdf" }

Respuesta de ejemplo (predeterminada):

{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }

2) Carga de documentos (PUT)

Sube los documentos a la URL obtenida en el paso anterior. La API carga los archivos y devuelve si la carga se realizó correctamente.

Definiciones de API:

• URL
• Encabezamiento
• Parámetros
• Ejemplo
• Respuestas

URL

PUT <subirUrl>

Reemplace <uploadUrl> con la dirección del parámetro uploadUrl , devuelto en el paso anterior por la API requestUploadDocumentSign .

Encabezamiento

Reemplace <access_token> con la clave de acceso obtenida de la API de autenticación de la plataforma .

Cuerpo

* Obligatorio

Respuestas

Respuesta de ejemplo (200):

{ }

Respuesta de ejemplo (predeterminada):

{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }

3) enviar documentos (POST)

Enviar los sobres para la firma del candidato. La API envía documentos para que los candidatos los firmen y devuelve si la presentación fue exitosa.

Definiciones de API:

• URL
• Encabezamiento
• Parámetros
• Ejemplo
• Respuestas

URL

POST <url_plataforma> /t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/actions/documentsEnviar

Reemplace <url_plataforma> con la URL correspondiente a su entorno. Si es el entorno de producción, reemplácelo por: https://platform.senior.com.br

Encabezamiento

Reemplace <access_token> con la clave de acceso obtenida de la API de autenticación de la plataforma .

Parámetros

* Obligatorio

contratos:

firmante:

Ejemplo

  { "contratos": [ { gedDocumentURI": "GED:\\upload\\1.0\\{\"id\":\"872f39ed-bfca-4878-9bc8-b33c9214dd15\",\"fileName\":\" Doc1.pdf\",\"version\":\"version-e9af8a56-4dc8-4446-98ec-91a765a45eef\"}", "contractFileName": "contract-de-admissao.pdf", "contract": "Personalizado Document", "contractModelName": "contracto-de-admissao.pdf" } ], "demandGeolocation": false, "sendSms": false, "signer": [ { "signerName": "JOÃO SILVA", "signerEmail": "senior@senior.com.br", "signerPhone": "5547999999999", "signerInstructions": "Firmar electrónicamente estos documentos."   } ], "instructionsToSigner": "Firmar electrónicamente estos documentos.", "preAdmissionId": "bf036f5c-8b41-4c41-9d2b-6d60aabfb8cf" }  

Respuestas

Respuesta de ejemplo (200):

{ }

Respuesta de ejemplo (predeterminada):

{ "mensaje": "cadena", "motivo": "BAD_REQUEST" }