Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Catalog · How the catalog works
Anything · Lazarus or Delphi
Random projectRandom project

Classe-Consulta-CPF-API

Consulta de CPF via API com código-fonte compatível com Delphi 11 e Lazarus 4.0.

View on GitHub

Member rating

No ratings yet.

Sign in to rate this project.

README

Consulta de CPF - Delphi 11 e Lazarus 4.0

Projeto de exemplo para consulta de CPF utilizando a API CPF Brasil
Compatível com Delphi 11 e Lazarus 4.0, permitindo consultas de forma simples e estruturada.

🔗 Plataforma da API e obter TOKEN: Acessar portal de consulta CPF


📌 Recursos

  • Consulta CPF online com retorno estruturado.
  • Compatível com Delphi 11 e Lazarus 4.0.
  • Suporte a retorno de cotas utilizadas e mensagens de erro da API.
  • Tratamento de exceções e respostas em formato JSON.
  • Exemplo de integração com componentes visuais (TEdit, TLabel etc.).

🚀 Requisitos

🟢 Delphi

Compatível com:

  • XE8
  • 10 Seattle
  • 10.1 Berlin
  • 10.2 Tokyo
  • 10.3 Rio
  • 10.4 Sydney
  • 11 Alexandria
  • 12 Athens

Necessário:

  • System.Net.HttpClient (nativo)

Observação:
Delphi XE7 ou anteriores exigem uso de Indy (TIdHTTP) ou componente HTTP de terceiros. image


🔵 Lazarus

Compatível com:

  • FPC 2.x+
  • Lazarus até versão 4.0

Necessário:

  • fphttpclient
  • fpjson
  • jsonparser

image


📝 Exemplo de uso da Classe

procedure TfrmConsultaCPF.consultaCPF(token, CPF: string);
var
  api: TCpfBrasilOrg;
  retorno: TCpfData;
begin
  // informando TOKEN de autenticação
  api := TCpfBrasilOrg.Create( token );
  try
     // limpando TEDIT;
     edtNomeCompleto.Clear;
     edtNomedaMae.Clear;
     edtnascimento.Clear;
     edtsexo.Clear;
     
     //requisitando...
     retorno              := api.ConsultarCPF(CPF);
  
     // passando retorno ao componente visual TEDIT
     edtNomeCompleto.Text := retorno.Nome;
     edtNomedaMae.Text    := retorno.NomeMae;
     edtsexo.Text	      := retorno.Sexo;
     edtnascimento.Text   := retorno.Nascimento;
  
     lblStatus.Caption := Format('Mensagem: %s', [retorno.Msg]);
      lblStatus.Repaint;
  
  finally
    api.Free;
  end;

end;

📥 Instalação

  1. Clone este repositório:
    bash
    git clone https://github.com/fraurino/Classe-Consulta-CPF-API.git
    
    ## 📊 Retorno da API
    ## ✅ Resposta de sucesso:
    <pre> {
    "success": true,
    "data": {
     "CPF": "00000000000",
     "NOME": "Fulano de Tal",
     "SEXO": "M",
     "NASC": "01/01/1990",
     "NOME_MAE": "Maria Tal"
    },
    "quota": {
     "quota_used": 5,
     "quota_limit": 10,
     "quota_remaining": 5
    }
    }
    </pre>
    
    ## ❌ Resposta de erro (exemplo):
    <pre>{
    "error": "Quota Excedida",
    "message": "Sua quota mensal foi excedida. Faça upgrade ou aguarde o reset.",
    "code": "QUOTA_EXCEEDED",
    "action": "Acesse https://dash.cpf-brasil.org para upgrade",
    "quota_used": 10,
    "quota_limit": 10,
    "reset_date": "2025-09-01"
    }
    </pre>
    
    ## ⚠️ Aviso Importante
    
    Este projeto ?? apenas um exemplo de integra????o.  
    A API de consulta de CPF pertence a um provedor externo.
    
    Qualquer quest??o relacionada a:
    
    - Limites de uso  
    - Disponibilidade do servi??o  
    - Problemas t??cnicos da API  
    
    Deve ser tratada diretamente com o respons??vel pela API.
    
    ## 📄 Licença
    Este projeto ?? de uso livre para fins educacionais e at?? comerciais.
    Consulte os termos de uso da API em [Acessar portal de consulta CPF](https://aurino.com.br/consultacpf)
    
    ## ⚠️ Aviso: A API de consulta de CPF utilizada neste projeto não é de minha responsabilidade. Este projeto apenas integra a API para fins de consulta.
    ??? Qualquer problema relacionado ao servi??o, limites de uso ou quest??es t??cnicas devem ser ???? tratados diretamente com o provedor da API.