Gestão de Pessoas - senior X - Manual do Usuário > Admissão Digital > Integrações > Integração via APIs > Fazer o upload de documentos e enviar para assinatura (requestUploadDocumentSign e documentsSend)

Fazer o upload de documentos e enviar para assinatura — APIs da Admissão Digital

A Admissão Digital dispõe de APIs que permitem fazer o upload de documentos e enviá-los para candidatos assinarem eletronicamente.

Primeiro, é necessário fazer a autenticação na Plataforma Senior X para obter o token de acesso que permite fazer as requisições. Depois, o processo é feito em três etapas:

POST requestUploadDocumentSign — Solicita a URL para upload do arquivos dos documentos. A API envia a solicitação de upload e retorna a URL onde os arquivos serão armazenados.
PUT <uploadUrl> — Faz o upload dos documentos para a URL obtida no passo anterior. A API faz o upload dos arquivos e retorna se o upload foi feito com sucesso.
POST documentsSend — Envia os documentos para a assinatura do candidato e retorna se o envio foi feito com sucesso.

Etapas para implementar a integração:

Diagrama demonstrando as etapas da integração via APIs

Documentação de referência:

Autenticação (Plataforma Senior X)
requestUploadDocumentSign (POST)
requestUploadDocumentSign (PUT)
documentsSend (POST)

1) requestUploadDocumentSign (POST)

Enviar a solicitação de upload e retornar a URL para onde deverá ser feito o upload dos arquivos.

URL

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

Substitua <url_plataforma> pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por: https://platform.senior.com.br

Cabeçalho (Header)

Authorization	Bearer <access_token>
Content-Type	application/json

Substitua <access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

Parâmetros

* Obrigatórios

Parâmetro	Tipo	Descrição
fileName *	String	Nome que corresponde ao nome do arquivo a ser enviado.

Exemplo

{
  "fileName": "contrato-de-admissao.pdf"
}

Respostas

Código

Descrição

Campos da resposta

200

Ok - resultado da solicitação da URL do arquivo

Campo	Tipo	Descrição
fileUrl	String	Identificador URI (Uniform Resource Identifier) do arquivo. Essa informação será necessária para fazer a próxima requisição — requestUploadDocumentSign (PUT).
uploadUrl	String	Endereço URL para onde será feito o upload do arquivo.

401

Invalid credentials

default

Error response

Campo	Tipo	Descrição
message	String	Mensagem descritiva do erro.
reason	String	Um código que representa a categoria da causa do erro.

2) Upload dos documentos (PUT)

Fazer o upload dos documentos para a URL obtida no passo anterior. A API faz o upload dos arquivos e retorna se o upload foi feito com sucesso.

Definições da API:

URL
Cabeçalho
Parâmetros
Exemplo
Respostas

URL

PUT <uploadUrl>

Substitua <uploadUrl> pelo endereço do parâmetro uploadUrl, retornado no passo anterior pela API requestUploadDocumentSign.

Cabeçalho (Header)

Authorization	Bearer <access_token>
Content-Type	application/json

Substitua <access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

Corpo (Body)

* Obrigatórios

Conteúdo	Tipo	Descrição
Arquivo *	Binary	O corpo da requisição deve conter o arquivo binário do qual será feito o upload.

Respostas

Código

Descrição

Campos da resposta

200

Ok - resultado da solicitação de upload do arquivo

401

Invalid credentials

default

Error response

Campo	Tipo	Descrição
message	String	Mensagem descritiva do erro.
reason	String	Um código que representa a categoria da causa do erro.

3) documentsSend (POST)

Enviar os envelopes para a assinatura do candidato. A API envia os documentos para a assinatura dos candidatos e retorna se o envio foi feito com sucesso.

Definições da API:

URL
Cabeçalho
Parâmetros
Exemplo
Respostas

URL

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

Substitua <url_plataforma> pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por: https://platform.senior.com.br

Cabeçalho (Header)

Authorization	Bearer <access_token>
Content-Type	application/json

Substitua <access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

Parâmetros

* Obrigatórios

Parâmetro	Tipo	Descrição
contracts { } *	-	Um array que contém os parâmetros que identificam todos os documentos a serem enviados para assinatura. Deve conter todos os documentos que foram enviados anteriormente, em requisições para a API requestUploadDocumentSign.
demandGeolocation	Boolean	Indica se deve-se solicitar a geolocalização da pessoa no momento da assinatura do documento.
sendSms	Boolean	Indica se deve-se enviar o link de assinatura por SMS para os assinantes.
signer { } *	-	Um array de parâmetros que identificam os assinantes dos documentos.
instructionsToSigner *	String	Instruções padrão para o envelope de documentos, para a pessoa candidata.
preAdmissionId *	String	Identificador (ID) da pré-admissão.

contracts:

Parâmetro	Tipo	Descrição
gedDocumentURI	String	Endereço URI que foi retornado pela requisição da API requestUploadDocumentSign, no parâmetro fileUrl.
contractFileName	String	Nome do arquivo do documento.
contract	String	Tipo do arquivo do documento. O valor sempre será Custom Document.
contractModelName	String	Nome do arquivo do documento.

signer:

Parâmetro	Tipo	Descrição
signerName	String	Nome do assinante.
signerEmail	String	E-mail do assinante.
signerPhone	String	Telefone de contato do assinante.
signerInstructions	String	Instruções para a pessoa candidata sobre a assinatura.

Exemplo

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

Respostas

Código

Descrição

Campos da resposta

200

Ok - resultado do envio para assinatura

401

Invalid credentials

default

Error response

Campo	Tipo	Descrição
message	String	Mensagem descritiva do erro.
reason	String	Um código que representa a categoria da causa do erro.

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas \| HCM - senior X