Documentação da API

Integre nosso gerador ao seu site ou bot com endpoints simples e seguros

Minhas API Keys

Base

/api/v1

Autenticação

Header x-api-key

Rate Limit

por plano e por minuto

Endpoints

GET

/api/v1/services

Lista serviços ativos com estoque disponível

curl -H "x-api-key: SUA_API_KEY" https://SEU_DOMINIO/api/v1/services
{
  "success": true,
  "services": [
    { "id": "svc123", "name": "Netflix", "description": null, "icon": "🎬", "stockAvailable": 42 }
  ]
}

GET

/api/v1/stock/availability?serviceId=ID

Verifica disponibilidade e métricas de estoque

curl -H "x-api-key: SUA_API_KEY" "https://SEU_DOMINIO/api/v1/stock/availability?serviceId=svc123"
{
  "success": true,
  "service": { "id": "svc123", "name": "Netflix" },
  "availability": {
    "available": 42,
    "total": 120,
    "isAvailable": true,
    "lastAddedAt": "2026-02-04T02:30:00.000Z",
    "lastUsedAt": "2026-02-04T03:10:00.000Z"
  }
}

POST

/api/v1/generate

Gera credenciais do serviço escolhido

curl -X POST -H "x-api-key: SUA_API_KEY" -H "Content-Type: application/json" \
  -d '{ "serviceId": "svc123" }' https://SEU_DOMINIO/api/v1/generate
{
  "success": true,
  "account": {
    "username": "user@example.com",
    "password": "secret",
    "email": "user@example.com",
    "extraData": null
  },
  "usage": { "used": 11, "limit": 100, "remaining": 89 }
}

GET

/api/v1/history?page=1&limit=20

Histórico das suas gerações (sem credenciais)

curl -H "x-api-key: SUA_API_KEY" https://SEU_DOMINIO/api/v1/history
{
  "success": true,
  "history": [
    { "id": "gen_abc", "service": { "id": "svc123", "name": "Netflix" }, "createdAt": "2026-02-04T03:12:00.000Z" }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 48, "totalPages": 3, "hasPrev": false, "hasNext": true }
}

GET

/api/v1/status

Quota, rate limit e últimas gerações

curl -H "x-api-key: SUA_API_KEY" https://SEU_DOMINIO/api/v1/status
{
  "success": true,
  "apiKey": {
    "plan": "API Pro",
    "monthlyGenerations": 100,
    "usedGenerations": 11,
    "remainingGenerations": 89,
    "rateLimit": 120,
    "isActive": true
  }
}

Segurança e Limites

  • IP whitelist por key: se configurada, somente IPs permitidos podem usar
  • allowedServiceIds por key: restringe serviços que a key pode gerar
  • Rate limit por plano e por minuto
  • Limite mensal de gerações por key
  • Limite de quantidade de API keys ativas por plano
  • Logs de uso por chamada com IP e user-agent

Exemplo em Node

import axios from 'axios'
const api = axios.create({ baseURL: 'https://SEU_DOMINIO/api/v1', headers: { 'x-api-key': process.env.API_KEY } })
const { data: services } = await api.get('/services')
const svc = services.services[0].id
const { data: avail } = await api.get('/stock/availability', { params: { serviceId: svc } })
if (avail.availability.isAvailable) {
  const { data: gen } = await api.post('/generate', { serviceId: svc })
  console.log(gen.account)
}

Exemplo em Python

import requests, os
base = 'https://SEU_DOMINIO/api/v1'
headers = { 'x-api-key': os.environ['API_KEY'] }
r = requests.get(f'{base}/services', headers=headers).json()
svc = r['services'][0]['id']
a = requests.get(f'{base}/stock/availability', headers=headers, params={'serviceId': svc}).json()
if a['availability']['isAvailable']:
  g = requests.post(f'{base}/generate', headers={**headers, 'Content-Type':'application/json'}, json={'serviceId': svc}).json()
  print(g['account'])

Boas Práticas

  • Implemente retry respeitando o retryAfter em respostas 429
  • Cacheie respostas de serviços e disponibilidade por alguns segundos
  • Não exponha sua API key em clientes; use um backend
  • Registre logs de falhas e sucesso para suporte

© 2026 Kaizen Gens. Todos os direitos reservados