Documentação da API do Recruit CRM (Nova UI) | Recruit CRM

Importante: A Open API só está disponível para quem está no plano "Business" ou superior. Alternativamente, empresas com parceria formal com o Recruit CRM também podem acessar a API. Além disso, só o dono da conta pode gerenciar as chaves de API, aumentando a segurança.

O que esse recurso faz e quando usar?

A API do Recruit CRM permite que sistemas e aplicações externas interajam com os dados do Recruit CRM de forma segura, usando métodos HTTP padrão como GET, POST e DELETE. Com um token de API para autenticação, você conecta o Recruit CRM a ferramentas de terceiros e aplicações customizadas.

Você pode usar esse recurso quando:

Quer conectar o Recruit CRM a ferramentas externas, aplicações customizadas ou dashboards de relatórios
Você é desenvolvedor implementando autenticação de API e integrações seguras
Precisa de acesso à API para automatizar criação de candidatos, análise de currículos, coleta de timesheets ou sincronização de dados
Quer criar fluxos customizados e integrações usando dados do Recruit CRM

Nossa documentação da API está disponível em https://docs.recruitcrm.io

Nota importante para o desenvolvedor

Ao usar a nossa API para GET/POST/DELETE os dados necessários, nunca faça chamadas diretamente do front-end/página web, pois isso expõe o token da API. Você precisa proteger o token da API do Recruit CRM/Bearer token. Isso é feito colocando um servidor intermediário ou tornando o token abstrato. Basicamente, o front-end faz uma requisição para um servidor privado, que aí sim consulta a API do Recruit CRM.

Esse é o jeito mais seguro, porque assim o token da API do Recruit CRM nunca fica exposto publicamente.

Se você encontrar algum erro ao usar a chave da API, confira se não está em uma conta de Free Trial e gerando uma nova chave de API, pois isso pode causar o erro 401 Authorization (INSUFFICIENT_ACCESS - Faça upgrade para “Business” ou “Enterprise” para liberar acesso à Open API).

Tokens de API estão disponíveis em todos os planos para integração com Workflow Automation (acessível em todos os planos), mas o acesso à nossa API pública exige plano Business ou superior.

Essas restrições servem para proteger dados sensíveis da organização e garantir que os tokens de API sejam gerenciados por pessoas de confiança. O Recruit CRM prioriza a segurança limitando o acesso à API apenas para donos de conta, garantindo a integridade dos dados.

Acesso à API: Dono da conta vs. Admins

Mesmo tendo cargo de Admin no Recruit CRM, você não consegue gerar ou recuperar o token da API se não for também o dono da conta. Isso aumenta a segurança, limitando o acesso à pessoa mais confiável da empresa. Se você for Admin e precisar de acesso à API, pode:

Pedir para o dono da conta pegar a chave para você, ou
Solicitar que o dono crie um cargo personalizado com permissão para acessar o token da API.

Como acessar seu token da API?

Veja o passo a passo para ativar e copiar seu token da API como dono da conta.

1. Vá em Admin Settings.

2. Desça a tela e clique em API para abrir a seção de API. Obs: Só o dono da conta pode acessar e gerenciar essa seção para garantir a segurança.

3. Ative o toggle para ligar o token da API.

4. Copie o token que aparecer. Guarde-o em segurança na sua ferramenta de integração, configuração do servidor backend ou secret manager. Evite salvar em arquivos de texto ou compartilhar por canais inseguros.

Criar um candidato via endpoint da API

Você pode usar o endpoint 'Creates a new candidate/Criar um novo candidato' para criar um novo candidato:

Analisar um currículo via endpoint da API

Você pode usar a API 'Resume Parser' para fazer o upload de um currículo e criar ou atualizar automaticamente um candidato no Recruit CRM. Na documentação dos endpoints da API, selecione o endpoint 'Resume Parser' e faça o upload do arquivo de currículo em um formato compatível, como PDF, DOC, DOCX ou RTF.

Após o envio da solicitação, o sistema lerá o currículo e extrairá informações básicas como nome do candidato, número de telefone, e-mail, cidade, endereço completo, especialização, ano e mês de experiência profissional, empresa atual, cargo, habilidades, idiomas, resumo, formação acadêmica, histórico profissional e acadêmico e URLs de redes sociais como Facebook, Twitter, LinkedIn, GitHub e Xing (se houver).

Tratamento de Duplicados

O tratamento de duplicados baseia-se na configuração “Permitir Candidatos Duplicados” em Configurações do Administrador → Gerenciamento de Contas.

Se essa configuração estiver ativada, um novo candidato será sempre criado.
Se essa configuração estiver desativada, o sistema verifica se já existe um candidato e atualiza o registro com base nos dados do currículo analisados.

Substituição de dados existentes

Você pode controlar como os dados de candidatos existentes são atualizados usando o parâmetro override_data.

Se estiver definido como não, apenas os campos vazios ou ausentes serão preenchidos e os dados existentes permanecerão inalterados.
Se estiver definido como sim, os detalhes do candidato existente serão atualizados com as informações recém-analisadas.
Se candidatos duplicados forem permitidos, essa configuração será ignorada e um novo candidato será criado.

Observação

A análise de campos personalizados não é compatível.
A análise em lote ou a análise de vários currículos em uma única chamada não é compatível.

Puxar todos os timesheets via endpoint da API

Você pode obter uma lista de todos os registros de ponto do Recruit CRM usando o endpoint "Obter todos os registros de ponto". Isso permite acessar os dados dos registros de ponto, facilitando a integração com sistemas externos, como ferramentas de folha de pagamento ou de geração de relatórios.

Buscar detalhes de timesheet via endpoint da API

Você pode obter informações detalhadas de uma folha de ponto específica usando o endpoint 'Obter Folha de Ponto por ID'.

Isso permite acessar registros completos da folha de ponto, incluindo registros detalhados de tempo.

Additionally, two response parameters, is_contractor and contractor_status, are available across the following six existing candidate endpoints:

Search for Candidates, Edit Candidate, Find Candidate by Slug, Get List of candidates which are marked as off limit, Show All Candidates, and Un-assign Candidate.

Solução de problemas

Problema: Você não vê a seção de API ou o token da API em Admin Settings.

Causa provável: Você não está conectado como proprietário da conta.

O que verificar: Confirme sua função (proprietário da conta, administrador ou outra).

Solução: Faça login como proprietário da conta ou peça ao proprietário da conta para recuperar o token para você ou criar uma função personalizada que conceda acesso ao token da API.

FAQs

Quem pode gerenciar e visualizar o token da API do Recruit CRM?

Por padrão, somente o proprietário da conta pode gerenciar e recuperar o token da API. Usuários administradores não podem acessar o token, a menos que o proprietário da conta conceda uma função personalizada com permissão explícita para acessar o token da API.

A API está disponível em todos os planos do Recruit CRM?

Não. A API está disponível apenas para usuários do plano Business ou superior. Organizações com parceria formal com a Recruit CRM também podem se qualificar para acesso à API.

Posso chamar a API do Recruit CRM direto do meu site ou aplicação do lado do cliente?

Não. Você não deve consultar diretamente o endpoint da API a partir de uma página web ou aplicação do lado do cliente usando o token da API, pois isso expõe o token e pode comprometer a segurança dos seus dados. Sempre utilize o token da API no lado do servidor.

Onde posso encontrar a documentação oficial da API do Recruit CRM?

A documentação da API está disponível online no link da documentação da API do Recruit CRM: https://docs.recruitcrm.io

Conclusão:

Usar a API do Recruit CRM com segurança começa garantindo que só usuários autorizados gerenciem o token da API e que ele nunca fique exposto no front-end. Seguindo os requisitos de cargo, plano e as dicas deste artigo, você pode ativar integrações com confiança.

Para ver todos os endpoints, parâmetros e formatos de resposta disponíveis, acesse a documentação oficial da API em docs.recruitcrm.io.

Se precisar de ajuda, use o ícone de chat no canto inferior direito da tela para falar com o suporte.