Skip to content

API de consulta de dados pessoais brasileiros via CPF atravez do SUS

License

Notifications You must be signed in to change notification settings

lalaio1/InfoSUS_API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🔍 CPF Lookup Service

./1.pgn

✨ Funcionalidades

  • 🔐 Autenticação segura com credenciais
  • 📡 Consulta de informações pessoais por CPF
  • 🔁 Tratamento de múltiplas tentativas de requisição
  • 🛡️ Manipulação de erros robusta

🛠️ Requisitos Técnicos

Tecnologia Versão Mínima
Node.js 14.x
TypeScript 4.x
npm 6.x

🚀 Instalação

Passo a Passo

  1. Clone o repositório
git clone https://github.com/lalaio1/InfoSUS_API
cd InfoSUS_API
  1. Instale as dependências
npm install
  1. Configuração das Credenciais
  • Abra o arquivo index.ts
  • Substitua SEU_EMAIL_AQUI e SUA_SENHA_AQUI com suas credenciais

🔧 Configuração

Crie um arquivo tsconfig.json na raiz do projeto:

{
  "compilerOptions": {
    "target": "es2020",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  }
}

💻 Scripts de Execução

Script Comando Descrição
Desenvolvimento npm run dev Inicia o servidor em modo de desenvolvimento
Compilar npm run build Compila o TypeScript para JavaScript
Iniciar npm start Inicia o servidor de produção

🌐 Uso da API

Consulta de CPF

GET /cpf?cpf=NUMERODOCPF

Exemplo de Requisição

curl http://localhost:3000/cpf?cpf=12345678900

📊 Estrutura de Resposta

Campo Tipo Descrição
nome string Nome completo
dataNascimento string Data de nascimento
sexo string Sexo
nomeMae string Nome da mãe
ativo boolean Status de atividade
racaCor string Raça/Cor

🚧 Tratamento de Erros

  • ❌ CPF não informado: Retorna erro 400
  • 🔒 Falha de autenticação: Retorna erro de login
  • 📭 Dados não encontrados: Retorna mensagem específica

About

API de consulta de dados pessoais brasileiros via CPF atravez do SUS

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published