API Documentation

API REST para geração e validação de dados brasileiros. Rápida, confiável e fácil de usar.

Rápida
Respostas em milissegundos com infraestrutura otimizada
Segura
Autenticação via API key com rate limiting inteligente
Monitorada
Acompanhe seu uso em tempo real com estatísticas detalhadas
Quick Start
Comece a usar a API em 3 passos simples
1

Obtenha sua API Key

Acesse /settings/api-keys e crie uma nova chave

2

Faça sua primeira requisição

Use sua API key no header x-api-key

// Generate CPF
const response = await fetch('https://devthru.com/api/v1/generate/cpf', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY'
  },
  body: JSON.stringify({
    quantity: 10,
    options: { formatted: true }
  })
});

const data = await response.json();
console.log(data);
// { success: true, data: ["123.456.789-00", ...], count: 10 }
3

Monitore seu uso

Acompanhe suas estatísticas em tempo real via GET /api/v1/usage

Endpoints Disponíveis
Todos os endpoints requerem autenticação via API key
POST
/api/v1/generate/{tool}

Gera dados para testes. Suporta: cpf, cnpj, rg, cnh, inscricao-estadual, titulo-eleitor, pis, name, email, phone, address, person, license-plate, renavam, chassis, credit-card, iban, uuid, password, lorem

Ver exemplo

Request:

{
  "quantity": 10,
  "options": { "formatted": true }
}

Response:

{
  "success": true,
  "data": ["123.456.789-00", ...],
  "count": 10
}
POST
/api/v1/validate/{tool}

Valida documentos brasileiros. Suporta: cpf, cnpj, pis, titulo-eleitor, cnh, iban, inscricao-estadual

Ver exemplo

Request:

{
  "value": "123.456.789-00"
}

Response:

{
  "success": true,
  "valid": true,
  "value": "123.456.789-00"
}
GET
/api/v1/usage

Retorna estatísticas de uso da API

Ver exemplo

Response:

{
  "success": true,
  "period": "monthly",
  "used": 150,
  "limit": 1000,
  "remaining": 850,
  "resetAt": "2025-12-01T00:00:00Z",
  "topTools": [
    { "tool": "cpf", "count": 80 },
    { "tool": "cnpj", "count": 45 }
  ]
}
Rate Limits
Limites de uso por plano de assinatura

Free Plan

-

Sem acesso à API

Pro Plan

-

Sem acesso à API

Business Plan

1,000,000

requests por mês

Todas as respostas incluem headers de rate limit: X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset

Códigos de Erro
Possíveis erros retornados pela API
INVALID_API_KEYAPI key inválida ou ausente
RATE_LIMIT_EXCEEDEDLimite de requisições excedido
INVALID_INPUTDados de entrada inválidos
TOOL_NOT_FOUNDFerramenta não encontrada
INTERNAL_ERRORErro interno do servidor
Documentação da API | DevThru