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:

1. 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.
2. 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.
3. 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:

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.

Definições da API:

• URL
• Cabeçalho
• Parâmetros
• Exemplo
• Respostas

URL

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)

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

Parâmetros

Exemplo

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

Respostas

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

    {
        "message": "string",
        "reason": "BAD_REQUEST"
    }

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

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

Cabeçalho (Header)

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

Corpo (Body)

Respostas

    { }

    {
        "message": "string",
        "reason": "BAD_REQUEST"
    }

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

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)

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

Parâmetros

contracts:

signer:

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

    { }

    {
        "message": "string",
        "reason": "BAD_REQUEST"
    }