API Documentation

Gere dados brasileiros fictícios via API REST. Sem autenticação, sem cadastro. Retorna JSON por padrão, ou CSV e SQL sob demanda.

Base URL

https://seu-dominio.com/api/generate

GET/api/generate

Gera dados via query parameters.

Parâmetros

Param	Tipo	Default	Descrição
type	string	-	Tipo de dado (ver tabela abaixo)
quantity	number	10	Quantidade (1 a 10.000)
formatted	boolean	true	Incluir pontuação (123.456.789-00 vs 12345678900)

Exemplo

# Gerar 5 CPFs formatados

curl "/api/generate?type=cpf&quantity=5"

# Resposta

{
  "type": "cpf",
  "quantity": 5,
  "data": [
    "123.456.789-09",
    "987.654.321-00",
    ...
  ]
}

POST/api/generate

Gera dados via JSON body. Suporta export em CSV e SQL.

Body (JSON)

Campo	Tipo	Descrição
type	string	Tipo de dado
quantity	number	Quantidade (1 a 10.000)
formatted	boolean	Incluir pontuação
format	string	"json" (padrão), "csv", ou "sql"

Exemplos

# Gerar 10 endereços em CSV

curl -X POST /api/generate \

-H "Content-Type: application/json" \

-d '{"type":"address","quantity":10,"format":"csv"}'

# Gerar 100 empresas em SQL

curl -X POST /api/generate \

-H "Content-Type: application/json" \

-d '{"type":"company","quantity":100,"format":"sql"}'

Tipos disponíveis

Documentos

cpf	CPF	Cadastro de Pessoa Física (válido)
cnpj	CNPJ	Cadastro Nacional de Pessoa Jurídica (válido)

Pessoa

person	Pessoa Completa	Nome, sobrenome e gênero
fullName	Nome Completo	Nome e sobrenome brasileiro
firstName	Primeiro Nome	Nomes populares brasileiros
lastName	Sobrenome	Sobrenomes comuns no Brasil

Contato

email	Email	Email com domínios BR e internacionais
phone	Celular	Número de celular com DDD válido
landline	Telefone Fixo	Número fixo com DDD válido

Endereço

cep	CEP	Código de Endereçamento Postal
address	Endereço Completo	Rua, bairro, cidade, estado e CEP

Financeiro

bankAccount	Conta Bancária	Banco, agência e conta
pixKey	Chave PIX	CPF, email, telefone ou aleatória
creditCard	Cartão de Crédito	Visa, Mastercard ou Elo (Luhn válido)

Empresa

company

Empresa

CNPJ, razão social, endereço e contato

NEWSchema Builder & Presets

Gere registros com múltiplos campos correlacionados. O nome no email bate com o nome da pessoa, o endereço é consistente, e o cartão de crédito usa o nome do titular.

Presets prontos

Preset	Campos
customer	nome, cpf, email, telefone, endereço
employee	nome, cpf, email, telefone, endereço, conta bancária, pix
company	razão social, cnpj, telefone, endereço
ecommerce_order	cliente, cpf, email, telefone, endereço, cartão
contact_list	nome, email, celular, fixo

# Usar preset

curl "/api/generate?preset=customer&quantity=5"

# Schema customizado

curl -X POST /api/generate \

-H "Content-Type: application/json" \

-d '{"schema":[{"name":"nome","type":"fullName"},{"name":"doc","type":"cpf"},{"name":"contato","type":"email"}],"quantity":10}'

Integração

Node.js / TypeScript

const res = await fetch("https://fakeforge.com.br/api/generate", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ preset: "customer", quantity: 50 }),
});
const { data } = await res.json();
console.log(data[0]); // { nome, cpf, email, telefone, endereco }

Python

import requests

resp = requests.post("https://fakeforge.com.br/api/generate", json={
    "preset": "customer",
    "quantity": 50
})
data = resp.json()["data"]
print(data[0])  # {'nome': '...', 'cpf': '...', ...}

CI/CD (GitHub Actions)

# .github/workflows/seed.yml
- name: Seed test database
  run: |
    curl -s -X POST https://fakeforge.com.br/api/generate \
      -H "Content-Type: application/json" \
      -d '{"preset":"customer","quantity":100,"format":"sql"}' \
      | psql $DATABASE_URL

Limites

Plano	Requests/dia	Max items/request	Preço
Free	100	10.000	Grátis
Dev	10.000	10.000	R$29/mês (em breve)
Team	100.000	10.000	R$79/mês (em breve)

Headers de rate limit: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset