Identidade e contactos
Função, nome, apelido, morada, cidade, país, telefone e endereços de e-mail disponíveis.
API REST de parsing de CV · integração ATS e RH
Integre o parsing de CV no seu ATS por meio de uma API REST
Envie um CV para a API REST do CVReaderPro, receba uma resposta estruturada e utilize os dados no seu ATS, software de RH ou aplicação empresarial.
Teste de 14 dias · 200 créditos · sem cartão de crédito
Do documento aos dados
CV enviado → dados estruturados → utilização no seu software
O CVReaderPro extrai os dados do documento. O seu backend recebe a resposta e decide como a mapear, guardar e apresentar no seu modelo de candidato.
- 01
1. Enviar o CV
O seu backend envia o ficheiro para um endpoint de parsing.
- 02
2. Escolher o parser
Selecione o modo de acordo com o documento e o detalhe necessário.
- 03
3. Receber os dados
A API devolve propriedades estruturadas numa resposta JSON ou XML.
- 04
4. Utilizar o resultado
A aplicação associa os campos devolvidos ao seu ATS, CRM ou base de candidatos.
Que dados pode obter de um CV?
As propriedades devolvidas dependem do parser selecionado e das informações detetadas no documento.
Experiência profissional
Funções, empresas, períodos, localizações, descrições e indicação de emprego atual.
Formação
Graus, instituições, datas e descrições disponíveis.
Competências e idiomas
Competências estruturadas, idiomas detetados e níveis identificáveis.
Perfil e nível de experiência
Texto do perfil, nível de experiência e formação quando devolvidos pelo parser.
Outras propriedades
Soft skills, referências, ligações sociais, interesses e texto extraído quando previsto pelo esquema.
Os 56 ou 96 campos são propriedades disponíveis, não valores garantidos. Informações ausentes ou inutilizáveis no CV podem ficar vazias.
Consultar os esquemas completos na documentaçãoExemplo de resposta
Do CV ao JSON estruturado
À esquerda está um CV PDF sintético; à direita, a respetiva resposta JSON IA 56 dos exemplos públicos. O bloco mostra dados que um ATS pode mapear para o seu próprio modelo de candidato.
CV de origem sintético
Alex Sample — Senior Java Engineer — Paris. Perfil fictício usado para ilustrar o fluxo.
Transferir o CV de origem (PDF)Os valores são fictícios. Os campos e conteúdos preenchidos variam conforme o CV e o parser selecionado.
Descarregar o ficheiro JSON completo{
"documentType": "CV",
"documentLanguage": "en",
"candidate": {
"jobTitle": "Senior Java Engineer",
"title": "Mr",
"firstName": "Alex",
"lastName": "Sample",
"dayOfBirth": "",
"monthOfBirth": "",
"yearOfBirth": "",
"address": "Paris, France",
"postalCode": "",
"city": "Paris",
"country": "FR",
"department": "",
"region": "",
"phone": "",
"mobilePhone": "",
"driverLicense": "",
"personalEmail": "alex.sample@example.invalid",
"professionalEmail": "",
"nationality": "",
"children": ""
},
"profile": "Synthetic senior Java engineer with 8 years of experience developing Java, Spring Boot and PostgreSQL services. Builds REST APIs and leads engineering teams.",
"experienceLevel": "96",
"experiences": [
{
"startMonth": "01",
"endMonth": "10",
"startYear": "2020",
"endYear": "2026",
"mission": "Senior Java Engineer",
"company": "Example Systems (synthetic)",
"location": null,
"description": "Built Spring Boot REST APIs and PostgreSQL services. Led a team of four engineers. Introduced CI pipelines and automated integration checks.",
"currentPosition": true
},
{
"startMonth": "09",
"endMonth": "12",
"startYear": "2018",
"endYear": "2019",
"mission": "Java Engineer",
"company": "Example Labs (synthetic)",
"location": null,
"description": "Developed Java backend services, SQL reports and REST integrations.",
"currentPosition": false
}
],
"educationLevel": "DESS, DEA, Grande Ecoles, Bac +5",
"educations": [
{
"dateReceived": "2018",
"title": "Master of Computer Science",
"school": "Example University (synthetic)",
"description": ""
}
],
"languages": [
{
"name": "English",
"level": "Fluent"
},
{
"name": "French",
"level": "Bilingual"
}
],
"skills": [
{
"name": "Spring Boot",
"level": "Confirmed"
},
{
"name": "Java",
"level": "Confirmed"
},
{
"name": "PostgreSQL",
"level": "Experienced"
}
],
"softSkills": [
"Leadership",
"problem solving",
"communication"
],
"references": [],
"socialLinks": null,
"hobbies": "",
"resumeId": "00000000-0000-0000-0000-000000000001"
}Início técnico
Fazer a primeira chamada à API
Autentique o pedido no servidor, envie o CV como multipart/form-data e processe a resposta estruturada.
1. Criar uma chave API
Gere uma chave na sua conta e guarde-a no servidor.
2. Enviar um documento
Chame o endpoint padrão com o ficheiro CV no campo file.
3. Escolher o modo
O parâmetro parserType é opcional no endpoint padrão.
4. Processar a resposta
Peça application/json e associe as propriedades no seu software.
Exemplo cURL
curl --fail-with-body -X POST "https://cvreaderpro.com/api/v2/resumes/parser" \
-H "Authorization: ApiKey YOUR_API_KEY" \
-H "Accept: application/json" \
-F "file=@resume.pdf" \
-F "parserType=ADVANCED"Opções do parser e endpoint alargado
Em POST /api/v2/resumes/parser, BASIC seleciona o parsing por regras (56 campos) e ADVANCED seleciona IA 56 (56 campos). Para IA 96, utilize POST /api/v2/resumes/extended-parser: é um endpoint separado, não um valor de parserType do endpoint padrão.
POST /api/v2/resumes/extended-parserO parser alargado aceita um ficheiro ou um campo text num pedido multipart. Envie exatamente uma entrada e consulte a documentação para os requisitos de acesso.
Documentação da APINão exponha uma chave API privada em JavaScript executado no browser. Consulte a documentação para parâmetros, erros e limites de cada endpoint.
Escolha o nível de parsing para a integração
Ajuste o parser ao contexto necessário e ao custo de processamento por CV.
| Modo | Créditos / CV | Campos disponíveis | Utilização típica |
|---|---|---|---|
| Parsing por regras | 1 | 56 | Extração padronizada para processar grandes volumes de CV. |
| Parsing IA 56 | 3 | 56 | Interpretação por IA quando o documento exige mais contexto. |
| Parsing IA 96 | 5 | 96 | Parser alargado para uma representação mais detalhada. |
A IA 96 utiliza um endpoint dedicado: POST /api/v2/resumes/extended-parser. Aceita um ficheiro ou texto, uma entrada por pedido. O acesso pode depender de um teste ativo ou do plano associado à chave API.
O número de campos disponíveis não garante que todos os valores sejam extraídos do CV.
Conhecer o parsing de CV por regrasPara equipas técnicas
Integre o parsing no seu ATS ou software de RH
O CVReaderPro fornece o parsing e os dados estruturados. A sua aplicação mantém o controlo do fluxo e do modelo de dados.
Fornecedores de ATS
Adicione extração de CV ao fluxo de candidaturas e mapeie a resposta para o seu modelo de candidato.
Software de RH
Envie os dados úteis para perfis de candidatos e fluxos de RH existentes.
Empresas de serviços tecnológicos e integrações internas
Ligue o parsing a ferramentas empresariais, portais de candidatos ou pipelines de processamento.
Equipas técnicas
Processe a resposta no backend, trate erros e escolha os dados a apresentar ou guardar.
A API fornece dados estruturados, não um conector nativo para cada ATS. O mapeamento, a interface e as regras de negócio são implementados ou configurados no seu software.
Respostas, erros e webhooks
Prepare a integração para tratar respostas corretas, erros e eventos assíncronos.
Parsing padrão
POST /api/v2/resumes/parserPOST /api/v2/resumes/parser devolve HTTP 200 em JSON ou XML, conforme o cabeçalho Accept.
400Ficheiro CV inválido.401Chave API em falta ou inválida.402Créditos insuficientes.403O parsing de ficheiros não está autorizado para esta chave ou conta.
Parser alargado
POST /api/v2/resumes/extended-parser403É necessário acesso ao parser ou um teste ativo.422Não foi possível analisar o documento.429Limite de pedidos do parser alargado atingido.
Formatos, limites técnicos e dados de candidatos
Os formatos atualmente indicados para a API de parsing de CV são:
- DOCX
O endpoint padrão recebe um ficheiro em multipart/form-data e o exemplo cURL utiliza um PDF. A página pública da API menciona PDF e DOCX; DOC e ficheiros .txt não estão confirmados para este endpoint. O endpoint alargado também aceita uma cadeia de texto no campo text, o que não confirma suporte para ficheiros .txt.
Limites a verificar antes da integração
- Os limites de tamanho dos ficheiros e de frequência dos pedidos dependem do endpoint.
- Prepare o tratamento de erros HTTP e respostas 429 quando for atingido um limite de pedidos.
- A documentação da API é a referência para os parâmetros e comportamentos de cada endpoint.
Quanto custa o parsing de CV pela API?
Os créditos são descontados por CV de acordo com o modo de parsing selecionado.
| Modo | Créditos / CV | Até este número de CV com 200 créditos |
|---|---|---|
| Parsing por regras | 1 | 200 |
| Parsing IA 56 | 3 | 66 |
| Parsing IA 96 | 5 | 40 |
Estes volumes pressupõem que os 200 créditos são utilizados num único modo. Não são contabilizadas frações de CV.
O teste inclui 200 créditos durante 14 dias, sem cartão de crédito. Teste CV representativos antes de desenvolver a integração completa.
Ver preços e créditosPerguntas frequentes sobre a API de parsing de CV
Como integro a API de parsing no meu ATS?
O seu backend envia o CV para a API, recebe a resposta estruturada e associa as propriedades aos campos do ATS. O mapeamento e a interface são geridos no seu software.
Como obtenho uma chave API?
Crie uma conta e gere uma chave na sua área. Utilize o cabeçalho Authorization: ApiKey e mantenha a chave privada no servidor.
Que formatos de CV posso enviar?
A página pública da API indica PDF e DOCX. A referência de POST /api/v2/resumes/parser utiliza um campo file multipart/form-data e um exemplo PDF; não confirma DOC nem ficheiros .txt. O endpoint alargado aceita uma cadeia de texto no campo text, não necessariamente um ficheiro TXT.
Que dados são devolvidos pela API?
Consoante o parser, a resposta pode incluir dados do candidato, experiência, formação, idiomas, competências, soft skills, referências, ligações sociais e outras propriedades do esquema.
Como escolho entre regras, IA 56 e IA 96?
O modo por regras disponibiliza 56 campos por 1 crédito por CV. IA 56 utiliza 56 campos por 3 créditos. IA 96 disponibiliza 96 campos por 5 créditos quando são necessários mais detalhes.
Todos os campos disponíveis são sempre preenchidos?
Não. Uma propriedade só é preenchida quando a informação está presente e pode ser utilizada no CV. O resultado varia conforme o documento e o parser.
Como recebo o resultado do parsing?
O endpoint padrão devolve a resposta ao pedido. Solicite JSON com o cabeçalho Accept: application/json; alguns fluxos assíncronos utilizam os webhooks documentados.
Quantos CV posso testar com 200 créditos?
Até 200 CV com parsing por regras, 66 com IA 56 ou 40 com IA 96 se todos os créditos forem utilizados num único modo.
Todos os endpoints estão disponíveis durante o teste?
O acesso depende do endpoint, da chave API e do plano ou teste ativo. Consulte a documentação para os requisitos do parser alargado.
Recursos para a integração
Explorar um exemplo sintético
Descarregue os CV de entrada e as saídas API capturadas. Todas as pessoas, empresas e vagas são fictícias. Os documentos de exemplo estão em inglês; os resultados dependem do documento e do parser e exigem revisão humana.
Teste a resposta de parsing com os seus CV
Verifique os dados devolvidos em documentos representativos e associe depois as propriedades ao seu ATS ou software de RH.
Teste de 14 dias · 200 créditos · sem cartão de crédito