### Exemplo de Requisição cURL para API de Consulta de CPF Source: https://www.apicpf.com/docs Demonstra como realizar uma requisição GET para a API de consulta de CPF utilizando cURL, incluindo a chave de API no cabeçalho. ```bash curl -X GET "https://apicpf.com/api/consulta?cpf=12345678900" \ -H "X-API-KEY: sua_chave_api_aqui" ``` -------------------------------- ### Exemplo de Requisição Fetch API para Consulta de CPF Source: https://www.apicpf.com/docs Utiliza a Fetch API em JavaScript para consultar dados de CPF, enviando a chave de API no cabeçalho e tratando a resposta JSON. ```javascript fetch('https://apicpf.com/api/consulta?cpf=12345678900', { method: 'GET', headers: { 'X-API-KEY': 'sua_chave_api_aqui' } }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error('Erro:', error)); ``` -------------------------------- ### Consulta por CPF Source: https://www.apicpf.com/docs Consulta dados de uma pessoa a partir do CPF. Requer uma chave de API válida no cabeçalho X-API-KEY. ```APIDOC ## GET /api/consulta ### Description Consulta dados de uma pessoa a partir do CPF. ### Method GET ### Endpoint /api/consulta ### Parameters #### Query Parameters - **cpf** (string) - Required - CPF da pessoa, com ou sem formatação (apenas números) ### Request Example ```bash curl -X GET "https://apicpf.com/api/consulta?cpf=12345678900" \ -H "X-API-KEY: sua_chave_api_aqui" ``` ### Response #### Success Response (200) - **code** (integer) - Código de status HTTP da resposta - **data.cpf** (string) - CPF completo com 11 dígitos (preenchido com zeros à esquerda se necessário) - **data.nome** (string) - Nome completo da pessoa - **data.genero** (string) - Gênero - "M" (Masculino), "F" (Feminino) ou "I" (Indefinido/Outro) - **data.data_nascimento** (string) - Data de nascimento no formato YYYY-MM-DD #### Response Example ```json { "code": 200, "data": { "cpf": "12345678900", "nome": "João da Silva", "genero": "M", "data_nascimento": "1985-07-15" } } ``` #### Error Responses - **400 Bad Request** - CPF não informado ```json { "code": 400, "message": "O parâmetro CPF é obrigatório" } ``` - **400 Bad Request** - CPF com formato inválido ```json { "code": 400, "message": "O CPF deve conter exatamente 11 dígitos" } ``` - **404 Not Found** - CPF não encontrado ```json { "code": 404, "message": "Pessoa não encontrada com o CPF informado" } ``` - **401 Unauthorized** - API Key não fornecida ```json { "code": 401, "message": "API key não fornecida" } ``` - **401 Unauthorized** - API Key inválida ```json { "code": 401, "message": "API key inválida" } ``` - **403 Forbidden** - API Key expirada ```json { "code": 403, "message": "API key expirada" } ``` - **429 Too Many Requests** - Limite diário excedido ```json { "code": 429, "message": "Limite diário excedido" } ``` - **429 Too Many Requests** - Limite por minuto excedido ```json { "code": 429, "message": "Limite de requisições por minuto excedido. Tente novamente em breve" } ``` - **429 Too Many Requests** - Limite de consultas repetidas com o mesmo CPF excedido ```json { "code": 429, "message": "Limite de consultas repetidas excedido" } ``` ``` -------------------------------- ### Resposta de Erro - CPF não encontrado Source: https://www.apicpf.com/docs Exemplo de resposta de erro (404 Not Found) quando o CPF informado não corresponde a nenhuma pessoa registrada. ```json { "code": 404, "message": "Pessoa não encontrada com o CPF informado" } ``` -------------------------------- ### Resposta de Sucesso da API de Consulta de CPF Source: https://www.apicpf.com/docs Formato JSON esperado para uma resposta de sucesso ao consultar um CPF, contendo o código de status e os dados da pessoa. ```json { "code": 200, "data": { "cpf": "12345678900", "nome": "João da Silva", "genero": "M", "data_nascimento": "1985-07-15" } } ``` -------------------------------- ### Exemplo de Requisição PHP cURL para Consulta de CPF Source: https://www.apicpf.com/docs Implementa uma requisição cURL em PHP para a API de consulta de CPF, configurando a URL, retorno e cabeçalho de autenticação. ```php $ch = curl_init(); c C: url_setopt($ch, CURLOPT_URL, 'https://apicpf.com/api/consulta?cpf=12345678900'); c C: url_setopt($ch, CURLOPT_RETURNTRANSFER, true); c C: url_setopt($ch, CURLOPT_HTTPHEADER, [ 'X-API-KEY: sua_chave_api_aqui' ]); $response = curl_exec($ch); $data = json_decode($response, true); c C: url_close($ch); ``` -------------------------------- ### Resposta de Erro - CPF não informado Source: https://www.apicpf.com/docs Exemplo de resposta de erro (400 Bad Request) quando o parâmetro CPF não é fornecido na requisição. ```json { "code": 400, "message": "O parâmetro CPF é obrigatório" } ``` -------------------------------- ### Resposta de Erro - Limite de consultas repetidas excedido Source: https://www.apicpf.com/docs Exemplo de resposta de erro (429 Too Many Requests) quando o limite de consultas repetidas com o mesmo CPF é excedido. ```json { "code": 429, "message": "Limite de consultas repetidas excedido" } ``` -------------------------------- ### Resposta de Erro - Limite por minuto excedido Source: https://www.apicpf.com/docs Exemplo de resposta de erro (429 Too Many Requests) indicando que o limite de requisições por minuto foi excedido. ```json { "code": 429, "message": "Limite de requisições por minuto excedido. Tente novamente em breve" } ``` -------------------------------- ### Resposta de Erro - API Key expirada Source: https://www.apicpf.com/docs Exemplo de resposta de erro (403 Forbidden) quando a chave de API utilizada já expirou. ```json { "code": 403, "message": "API key expirada" } ``` -------------------------------- ### Resposta de Erro - CPF com formato inválido Source: https://www.apicpf.com/docs Exemplo de resposta de erro (400 Bad Request) indicando que o CPF fornecido possui um formato inválido ou quantidade incorreta de dígitos. ```json { "code": 400, "message": "O CPF deve conter exatamente 11 dígitos" } ``` -------------------------------- ### Resposta de Erro - API Key não fornecida Source: https://www.apicpf.com/docs Exemplo de resposta de erro (401 Unauthorized) quando a chave de API não é incluída na requisição. ```json { "code": 401, "message": "API key não fornecida" } ``` -------------------------------- ### Resposta de Erro - Limite diário excedido Source: https://www.apicpf.com/docs Exemplo de resposta de erro (429 Too Many Requests) quando o limite diário de requisições à API foi atingido. ```json { "code": 429, "message": "Limite diário excedido" } ``` -------------------------------- ### Resposta de Erro - API Key inválida Source: https://www.apicpf.com/docs Exemplo de resposta de erro (401 Unauthorized) indicando que a chave de API fornecida é inválida. ```json { "code": 401, "message": "API key inválida" } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.