Guias Práticos

Fluxo de Download de Documentos de Admissão

Suggest Edits

O objetivo desse fluxo é permitir o download dos documentos e do contrato assinado pelo pré-colaborador através da API. Facilitando a operação do time de departamento pessoal da sua empresa com a redução de esforço manual de exportar os documentos das pessoas pré-colaboradoras para inserção nos seus sistemas internos e possibilitando a integração com GEDs e outros tipos de plataformas que armazenam documentos.

📘

Este fluxo utiliza webhook

Para realizar integrações utilizando Webhooks é necessário um agente integrador (middleware) para receber e tratar os dados.

Para implementar integrações a partir de webhooks é necessário uma configuração prévia através da própria API Gupy: Veja aqui mais informações sobre o recebimento de webhooks

❗️

Atenção!

Não é possível fechar VPN como rota para entrega do Webhook;

A URL usada para receber o Webhook (postbackUrl) DEVE ser um endereço HTTPS válido, exposto publicamente;

URLs com alta taxa de erro (100% dos erros nos últimos 7 dias) serão removidas sem aviso prévio.

O Webhook espera uma resposta em 30.000 ms. Caso a resposta não tenha ocorrido antes deste tempo, consideramos um timeout, consequentemente, um erro.

A Gupy garante pelo menos uma entrega, então podem haver vários Webhooks do mesmo evento, use a propriedade id para identificar duplicatas;

Não há garantia de ordem de entrega, use a propriedade date para verificar qual evento aconteceu primeiro e classifique os eventos;

NÃO USE serviços como requestcatcher, eles podem expor dados.

Quando setamos algum valor no clientHeaders, o header padrão 'Content-type: application/json;charset=utf-8' não é mais enviado, pois o valor dos headers passa a ser o que foi definido. Se for necessário que o Content-type tenha sempre o valor padrão, recomendamos passá-lo junto no clientHeaders.

Gerando o token

Para utilizar este fluxo, é necessário utilizar o Bearer Token gerado nas configurações avançadas da plataforma. Acesse nossa seção de autenticação para saber como gerar o o token de autenticação.

No momento de gerar o token habilite os seguintes endpoints da V1:

  • Webhook Configurations

Início do fluxo de Integração

Solicitar ao time do suporte da Gupy através do sitehttps://suporte.gupy.io/s/suporte/ a ativação da feature flag admission_concluded_webhook

Esse webhook é disparado apenas ao mover o candidato para a etapa de Admissão Concluída na plataforma.

Passo 1: Configurar webhook pre-employee-admission-concluded

  1. Acessar endpoint POST Webhook
  2. Alterar parâmetro action para pre-employee-admission-concluded
  3. Inserir no postbackUrl o endereço para onde será direcionado o webhook
  4. Inserir Bearer Token gerado no passo de autenticação e depois clicar em Try it!

Exemplo de requisição

curl --request POST \
     --url https://api.gupy.io/api/v1/webhooks \
     --header 'accept: application/json' \
     --header 'authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
     --header 'content-type: application/json' \
     --data '
{
     "action": "pre-employee-admission-concluded",
     "status": "active",
     "postbackUrl": "https://urldo.agenteintegrador.net",
     "techOwnerName": "Nome Sobrenome",
     "techOwnerEmail": "[email protected]"
}
'

Exemplo de Resposta

{
  "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "action": "pre-employee-admission-concluded",
  "postbackUrl": "https://urldo.agenteintegrador.net",
  "status": "active",
  "techOwnerName": "Nome Sobrenome",
  "techOwnerEmail": "[email protected]"
}

Passo 2: Identificando a etapa no Webhook

No payload recebido, procure pelo campo
body.data.admission.status: "ETAPA_DE_INTERESSE"

Nesse fluxo a etapa gatilho sempre será "ADMISSION_CONCLUDED"

Passo 3: Recebimento de informações

Neste momento é onde termina a atuação da Gupy na sua integração. Realizaremos a entrega do Webhook no agente integrador seguindo o contrato-JSON exemplificado na documentação. Como é possível ver pelo exemplo, o webhook disponibiliza uma URL para cada documento que o pré-colaborador subiu na plataforma da Gupy (inclusive uma para frente e outra o verso de um documento).

❗️

Atenção

A URL é um recurso que a AWS oferece para fornecer os arquivos, O tempo que configuramos para URL é de 7 dias ou 2-3 minutos após o primeiro acesso:

7 dias para o evento de movimentação para etapa de admissão concluída que disponibiliza o link

Por exemplo, se a PPC for movimentada quinta-feira, o evento estará disponível para ser acessado até a próxima quinta-feira.

2 a 3 minutos a partir do primeiro acesso

Por exemplo, se o link for acessado temos o tempo de 2 a 3 minutos para fazer o download dos documentos. Após esse tempo de disponibilidade do primeiro acesso, o link irá expirar.

Uma garantia de segurança a mais para os dados.

Tempo para expiração do link de primeiro acesso aos contratos

299 segundos ou +/- 5 minutos
O tempo é gerado pela Clicksign e não temos ação para alterar.

Passo 4: como testar

A Gupy não possui ambiente de testes. Por isso, quando surge a necessidade de um teste seguro, recomendamos que crie Vagas e Candidatos testes. No caso da Vaga, atentar-se para preencher com dados válidos para que a integração funcione, como o Código do cargo alinhado com o Centro de Custo correto. Para os Candidatos testes, é necessário gerar valores válidos também, como CPF, PIS e RG dentro do formato adequado, é possível encontrar na internet plataformas geradoras de dados como esses. Outra dica é utilizar e-mails descartáveis, para que não seja necessário criar diversas contas de e-mails para testar diferentes cenários.

Possíveis erros

Recebimento no agente integrador
O endpoint que recebe o Webhook precisa estar público para poder receber os dados, caso contrário, acontecerá um erro na entrega.

Dúvidas comuns:

  1. Estamos cobertos pela LGPD? Sim, houve avaliação de risco feita pelo nosso Jurídico para garantir que estamos em alinhamento com a Lei Geral de Proteção de Dados.
  2. Por que o disparo é na etapa de Admissão Concluída? Porque nesta etapa conseguimos garantir que os documentos foram validados e que o contrato foi assinado.
  3. É possível aumentar o tempo de expiração após o primeiro acesso? 2-3minutos é pouco. Sim, é possível configurar o aumento do tempo de expiração do link após o primeiro acesso para 12 horas (válido apenas para os documentos que são armazenados no ambiente da AWS da Gupy). Para aumentar solicite ao nosso time de suporte a ativação da
    feature flag admission_concluded_webhook_extended_url_expiration através de um chamado pelo site https://suporte.gupy.io/s/suporte/

Updated 2 months ago