Fluxo de Captação de Pessoas Candidatas em Vagas de Candidatura rápida

O Objetivo desta integração será criar na Gupy um candidato utilizando uma vaga do método de candidatura rápida.

Conceitos Importantes!

A aplicação em vagas de candidatura rápida permitem que a pessoa candidata forneça apenas informações essenciais como: nome completo, CPF ou documento de Identificação (para estrangeiros), e-mail, celular, perfil do LinkedIn (opcional), perguntas customizadas criadas pela empresa e arquivos de currículo.

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 token de autenticação.

No momento de gerar o token habilite os seguintes endpoints:

  • Endpoints completos da V1
  • Endpoints completos da V2

Fluxo de integração:

Fazendo a requisição e aplicando o candidato a vaga sem perguntas adicionais.

Faça a requisição para o endpoint /api/v2/applications/quick-apply, garantindo o preenchimento dos campos obrigatórios e levando as regras de negócio da candidatura em consideração.

Exemplo de requisição:

curl --request POST \
     --url https://api.gupy.io/api/v2/applications/quick-apply \
     --header 'accept: application/json' \
     --header 'authorization: Bearer *********************' \
     --header 'content-type: application/json' \
     --data '
{
  "jobId": 9842856,
  "name": "Jane Doe",
  "email": "[email protected]",
  "documentNumber": "68399792705",
  "mobileNumber": "+5519995279828",
  "countryOfOrigin": "BR",
  "linkedinProfileUrl": "https://www.linkedin.com/in/janedoe",
  "sendInvite": true
}

Exemplo de resposta:

{
  "id": 328451,
  "jobId": 9842856,
  "applicationId": 623733933,
  "candidateId": 59649902,
  "companyId": 266,
  "name": "Jane Doe",
  "email": "[email protected]",
  "documentNumber": "68399792705",
  "mobileNumber": "+5519995279828",
  "linkedinProfileUrl": "https://www.linkedin.com/in/janedoe",
  "hasDisqualifyingAnswer": false
}

Fazendo a requisição e aplicando o candidato a vaga com perguntas adicionais

Para aplicação de candidatos em vagas de candidatura rápida é possível enviar as respostas das perguntas cadastradas na vaga no ato da candidatura. Basta utilizar o parâmetro "questionFormAnswers”.

Para isso é necessário consultar o formulário de perguntas no endpoint question-forms e armazenar as seguintes informações: formId e questionId.

Depois inclua na requisição de cadastro do candidato, da seguinte forma:

curl --request POST \
     --url https://api.gupy.io/api/v2/applications/quick-apply \
     --header 'accept: application/json' \
     --header 'authorization: Bearer ****************************' \
     --header 'content-type: application/json' \
     --data '
{
  "questionFormAnswers": {
    "questions": [
      {
        "questionId": 8321,
        "answers": [
          "Resposta A"
        ]
      }
    ],
    "formId": 10364
  },
  "jobId": 9622636,
  "name": "Jane Doe",
  "email": "[email protected]",
  "documentNumber": "68739511618",
  "mobileNumber": "+5519995279828",
  "countryOfOrigin": "BR",
  "linkedinProfileUrl": "https://www.linkedin.com/in/janedoe",
  "sendInvite": true
}
'

Exemplo de resposta:

{
  "id": 334019,
  "jobId": 9622636,
  "applicationId": 624210771,
  "candidateId": 59649902,
  "companyId": 266,
  "name": "Jane Doe",
  "email": "[email protected]",
  "documentNumber": "68739511618",
  "mobileNumber": "+5519995279828",
  "linkedinProfileUrl": "https://www.linkedin.com/in/janedoe",
  "hasDisqualifyingAnswer": false
}

Informações importantes:

  • Quando a vaga incluir perguntas eliminatórias, o sistema verificará as respostas. Se uma delas for classificada como desclassificatória, a propriedade "hasDisqualifyingAnswer" retornará true. Se todas as respostas forem válidas, a propriedade retornará false.
  • Para consultar as respostas do formulário, utilize o seguinte endpoint: quick-apply/question-form-answers, informando o parâmetro applicationId.
  • A Criação das perguntas adicionais é feita apenas pela plataforma.
  • Para ver um exemplo deste fluxo aplicado em um chatbot, clique aqui.

Possíveis Erros: ⁣

  1. Caso possua uma pergunta obrigatória e não esteja sendo enviada na requisição, é retornado o seguinte erro:
{
  "statusCode": 400,
  "message": "required_answer_missing_for_question_2",
  "error": "Bad Request"
}
  1. Caso na requisição o documento informado esteja com a quantidade de caracteres ou informação incorreta, retornará o seguinte erro:
{
    "statusCode": 400,
    "message": "invalid_document_number",
    "error": "Bad Request"
}

observação: A API não realiza validação do número de telefone informado no campo "mobileNumber”