MockBite Iconmockbite
Documentação da API

Construa com MockBite em minutos.

Use chaves de API para acessar endpoints privados, gerar usuários falsos e rastrear o uso. Estes exemplos apontam para o backend local em http://localhost:8080.

GET /health

Check if the API is online.

Public
POST /waitlist

Capture an early access lead.

Public
POST /auth/register

Internal BFF route to issue an API key for logged-in users.

Internal
GET /me

Inspect the authenticated user and API key metadata.

Bearer API key
GET /v1/fake-user

Generate a fake user and track usage for the API key.

Bearer API key
GET /v1/usage

Read the total request count logged for the API key.

Bearer API key
Passo 1

Crie uma chave de API

As chaves agora são geradas com segurança via NextAuth. Siga estes passos para criar sua chave:

  1. Faça login na plataforma MockBite.
  2. Navegue até o seu Dashboard.
  3. Abra Configurações (⚙️) e clique em Gerar nova Chave de API.
Passo 2

Chame o endpoint privado

Envie sua chave de API usando o esquema de autorização Bearer.

curl "http://localhost:8080/v1/fake-user?country=Brazil&role=Backend%20Engineer&company=MockBite&seed=lucas" \
  -H "Authorization: Bearer df_your_api_key"
Passo 3

Abra o console

Cole a chave gerada no painel para inspecionar metadados da conta e o uso.

curl http://localhost:8080/v1/usage \
  -H "Authorization: Bearer df_your_api_key"
Parâmetros de consulta

Personalize usuários falsos

country

Override the generated user country.

role

Override the generated user role.

company

Override the generated user company.

seed

Select a deterministic name and email variation.

Respostas

Exemplos de payload

Cada solicitação autenticada para /v1/fake-user é registrada para rastreamento de uso.

{
  "name": "Maya Chen",
  "email": "maya@mockbite.dev",
  "company": "MockBite",
  "country": "Brazil",
  "role": "Backend Engineer"
}

O endpoint /v1/usage retorna métricas agregadas para a chave de API autenticada.

{
  "total_requests": 12,
  "last_24h": 5,
  "last_request_at": "2026-06-21T20:45:00Z",
  "by_endpoint": [
    {
      "endpoint": "/v1/fake-user",
      "requests": 12
    }
  ]
}
Limites de taxa

Prevenção de abusos

A API aplica um limite de requisições por janela de tempo para cada IP. Os padrões são configurados via variáveis de ambiente e podem ser ajustados.

RATE_LIMIT_MAX controls the request count.
RATE_LIMIT_WINDOW_SECONDS controls the time window.
X-RateLimit-Limit Maximum requests allowed in the current window.
X-RateLimit-Remaining Requests still available before the window resets.
X-RateLimit-Reset Unix timestamp for the current window reset.
Retry-After Seconds until retrying after the limit is exceeded.
Erros

Falhas comuns

400 invalid json payload

The request body could not be parsed.

401 missing bearer token

A private endpoint was called without Authorization.

401 invalid api key

The provided API key was not found or did not match.

429 rate limit exceeded

The client exceeded the configured request window.