01. VISÃO GERAL

Este documento apresenta os parâmetros de entrada e o retorno da API de POST de vaga.

  • A implementação das integrações via API deve ser realizada pelo cliente, que será responsável pelos custos e pelo desenvolvimento envolvidos.

02. ENDPOINT E PARÂMETROS DE ENTRADA

Endpoint da API que será utilizado para inserir e atualizar dados:

URL baseEndpoint
https://api-centraldorecrutador.totvs.app/recruitment-integration/swagger{URL base}/api/v1/job-opportunity


2.1 - DADOS ENVIADOS 

Segue abaixo um exemplo de corpo que deve ser enviado na API:

{
  "jobOpportunitiesCommand": [
    {
      "title": "string",
      "isInternal": false,
      "isExternal": false, 
      "isTalentBankCandidatesIncluded": false,
      "isCLT": false, 
      "isPJ": false,   
      "isInternship": false,   
      "isCooperated": false,
      "isFreelancer": false,     
      "positionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "facilityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "responsibilitiesDescription": "string",
      "requirementsDescription": "string",
      "roleDescription": "string", 
      "isHomeOffice": false,
      "isHybrid": false,
      "isLocal": false,
      "hiringLimitDate": "2025-02-13T11:10:08.323Z",
      "numberOfOpenings": 0,
      "requisitionReason": 0,
      "requisitionJustification": "string",
      "internalClientCode": "string",
      "hideLocation": true,
      "salaryMinimum": 0,
      "salaryMaximum": 0,
      "canPublishSalaryRange: true 
     }
  ]
}

Cada chamada de API não pode ser feita com mais de 100 vagas por vez.
Caso sejam adicionados mais de 100 vagas na lista, ocorrerá um erro avisando sobre o limite, e nenhuma vaga será adicionado ao sistema.

Descrição detalhada do objeto dentro do jobOpportunitiesCommand:

CampoDescriçãoTipoObrigatórioObservação:
title

Título da vaga

texto (string)

(seleção)

Não pode receber strings vazios ("")

isInternal

Se a vaga é Interna

true ou false (boolean)

(erro)


isExternal

Se a vaga é Externa

true ou false (boolean)

(erro)


isTalentBankCandidatesIncluded

Se a vaga é para Banco de Talentos

true ou false (boolean)

(erro)


isCLT

Regime de contratação CLT

true ou false (boolean)

(erro)


isPJ

Regime de contratação PJ

true ou false (boolean)

(erro)


isInternship

Regime de contratação Estágio

true ou false (boolean)

(erro)


isCooperated

Regime de contratação Cooperado

true ou false (boolean)

(erro)


isFreelancer

Regime de contratação Freelancer

true ou false (boolean)

(erro)


positionIdCódigo do cargotexto (string)(erro)Não pode receber strings vazios ("")
facilityIdCódigo da áreatexto (string)(erro)Não pode receber strings vazios ("")
responsabilitiesDescriptionResponsabilidades e atribuiçõestexto (string)(erro)Não pode receber strings vazios ("")
requirementsDescriptionRequisitos e qualificaçõestexto (string)(erro)Não pode receber strings vazios ("")
roleDescriptionDescrição da posiçãotexto (string)(erro)Não pode receber strings vazios ("")
isHomeOffice

Modelo de trabalho HomeOffice

true ou false (boolean)

(erro)


isHybrid

Modelo de trabalho Hibrido

true ou false (boolean)

(erro)


isLocal

Modelo de trabalho Presencial

true ou false (boolean)

(erro)


hiringLimitDateContratar atétexto (string)(erro)
numberOfOpeningsNúmero de posiçõesnúmero (int)(seleção)Deve ser maior que 0
internalClientCodeCódigo da vaga (interno ERP)texto (string)(erro)Não pode receber strings vazios ("")
requisitionReasonMotivo da requisiçãoenum com as seguintes opções:
0 - Nenhuma opção de requisição
1 - Aumento de quadro
2 - Substituição 		(erro)
requisitionJustification

Justificativa da requisição

texto (string)

(erro)

Não pode receber strings vazios ("")

hideLocation

Se deseja ocultar a localidade na página da vaga

true ou false (boolean)

(erro)


salaryMinimum

Valor mínimo para a faixa salarial da vaga

número (double)

(erro)


salaryMaximum

Valor máximo para a faixa salarial da vaga

número (double)

(erro)


canPublishSalaryRange

Se deseja que a faixa salarial seja divulgada

true ou false (boolean)

(erro)



Retorno:


Descrição

Valor string

O retorno é uma string que é o identificador do processo que será utilizado no endpoint de consulta para checar o status do processamento do lote

03. CONSULTANDO O RESULTADO DOS DADOS ENVIADOS

Endpoint da API que será utilizado para consultar os dados:

URL baseEndpoint
https://api-centraldorecrutador.totvs.app/recruitment-integration/swagger{URL base}/api/v1/process/{id}

1.1 - DADOS ENVIADOS 

Segue abaixo um exemplo de corpo que deve ser enviado na API:

{
  "id": "string",      
}

O id que deve ser informado na api é o resultado do item 2.