/cpf-validation-api

API de validação de CPF - verifique a validade de números de CPF brasileiros por meio desta solução fácil de usar.

Primary LanguagePython

API de Validação de CPF

Status

Esta é uma API de validação de CPF. Ela permite que você verifique se um CPF é válido e também gere CPFs válidos aleatórios. Hospedada em https://api-cpf.vercel.app/.

OBS: A validação é feita matematicamente, ou seja, usando apenas uma fórmula matemática demonstrada na seção [Recursos]

Validar CPF

2023-07-03_17h58_19

Gerar CPF's

image

Recursos

  • Validação de CPF: Verifica se um número de CPF é válido ou inválido.
  • Geração de CPFs: Gera uma lista de CPFs válidos.

Se baseia em uma fórmula matemática disponível em calculadorafacil para aprofundamento, e a fórmula é a seguinte:

  • Estrutura do CPF

cpf_formato

  • Formula base

cpf_digito_verificador_1

Documentação

Acesse a documentação da API para obter informações detalhadas sobre os endpoints, parâmetros e testes de requisições.

Como usar

  1. Rota principal ("/"): Retorna um JSON com uma descrição da API.
    (https://api-cpf.vercel.app/)
{
  "Status":true,
  "Description":"Api de validação CPF ON!"
}
  1. Rota de validação de CPF ("/cpf/valid/{cpf}"): Recebe um CPF e retorna um JSON com o resultado da validação.
    (https://api-cpf.vercel.app/cpf/valid/{cpf})
{
  "Valid": true,
  "CPF": "02511560364",
  "Status": "CPF valid!"
}
  1. Rota de geração de CPFs ("/cpf/generator/{qtd}"): Recebe a quantidade de CPFs a serem gerados e retorna uma lista de CPFs.
    (https://api-cpf.vercel.app/cpf/generator/{qtd})
{
  "944.455.117-22",
  "792.645.105-32",
  "252.035.413-53",
  "846.698.742-84",
  "587.367.725-50",
  "929.245.290-85",
  "246.988.777-17",
  "382.068.474-30",
  "563.825.185-57",
  "999.223.946-85"
}

Instalação

Pré-requisitos

Certifique-se de ter o Python 3 instalado. Você também pode criar um ambiente virtual para isolar as dependências do projeto.

  1. Clone este repositório:

    https://github.com/piedro404/cpf-validation-api.git
  2. Instale as dependências:

    pip install -r requirements.txt

Executando a API

  1. Execute o seguinte comando para iniciar a API:

    python main.py
  2. A API será executada localmente em http://localhost:8000.

Sobre

Obrigado a todos, desejo otimos estudos, caso queira, entre em contato em pedro.henrique.martins404@gmail.com.