AtalhoLab APIDocumentação
AtalhoLab para desenvolvedores · 78 endpoints

Uma API simples para dados sintéticos e utilitários.

Integre documentos sintéticos, JSON, marketing, texto, rede e cálculos de negócios com respostas previsíveis, créditos avulsos e sem armazenar o conteúdo processado.

Criar chaveTestar agora
POST /api/v1/cpf/generate
curl -X POST "https://atalholab.com.br/api/v1/cpf/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity": 2}'
01

Primeira chamada

Três passos para começar no ambiente de teste.

1

Crie um projeto

No painel da API, escolha o ambiente test.

2

Copie a chave

Ela aparece integralmente uma vez. Guarde-a em variável de ambiente.

3

Envie JSON

Use POST, Bearer token e Content-Type: application/json.

02

Autenticação e segurança

Cada requisição exige uma chave ativa com o escopo do endpoint.

Authorization: Bearer atl_test_••••••••_••••••••••••••••

Não coloque a chave em URL, código público ou repositório. Rotacione imediatamente se ela for exposta.

Ambientes isolados

O prefixo identifica chaves test ou live.

Escopos

Restrinja cada chave somente às operações necessárias.

IP e origem

Projetos podem limitar redes e origens autorizadas.

03

Teste um endpoint no navegador

A chave e o payload ficam somente nesta página e são enviados diretamente ao endpoint selecionado.

Uma resposta bem-sucedida consome os créditos indicados. A documentação não salva sua chave.

Aguardando teste
Os headers de saldo e limite aparecerão aqui.
{
  "message": "Preencha sua chave e envie a primeira requisição."
}
04

Referência de 78 endpoints

Custos e limites abaixo vêm do catálogo administrável atual.

POST/api/v1/cpf/generate1 crédito(s)

Gerar CPF sintético. Exige o escopo cpf:generate.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "quantity": 2,
    "formatted": true,
    "state": "SP"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/cpf/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity":2,"formatted":true,"state":"SP"}'
POST/api/v1/cpf/validate1 crédito(s)

Validar CPF. Exige o escopo cpf:validate.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "cpf": "529.982.247-25"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/cpf/validate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"cpf":"529.982.247-25"}'
POST/api/v1/cnpj/generate1 crédito(s)

Gerar CNPJ. Exige o escopo cnpj:generate.

Lote máximo
50
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "quantity": 1,
    "formatted": true,
    "alphanumeric": false
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/cnpj/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity":1,"formatted":true,"alphanumeric":false}'
POST/api/v1/cnpj/validate1 crédito(s)

Validar CNPJ. Exige o escopo cnpj:validate.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "cnpj": "04.252.011/0001-10"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/cnpj/validate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"cnpj":"04.252.011/0001-10"}'
POST/api/v1/person/generate2 crédito(s)

Gerar pessoa sintética. Exige o escopo person:generate.

Lote máximo
20
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "quantity": 1
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/person/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity":1}'
POST/api/v1/company/generate2 crédito(s)

Gerar empresa sintética. Exige o escopo company:generate.

Lote máximo
20
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "quantity": 1
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/company/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity":1}'
POST/api/v1/batch/generate5 crédito(s)

Gerar dados em lote. Exige o escopo batch:generate.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "type": "person",
    "count": 2,
    "format": "json"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/batch/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"type":"person","count":2,"format":"json"}'
POST/api/v1/json/format1 crédito(s)

Formatar JSON. Exige o escopo json:format.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "json": {
        "nome": "AtalhoLab",
        "versao": 1
    }
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/json/format" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"json":{"nome":"AtalhoLab","versao":1}}'
POST/api/v1/json/validate1 crédito(s)

Validar JSON. Exige o escopo json:validate.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "json": "{\"ok\":true}"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/json/validate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"json":"{\"ok\":true}"}'
POST/api/v1/uuid/generate1 crédito(s)

Gerar UUID. Exige o escopo uuid:generate.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "quantity": 3
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/uuid/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity":3}'
POST/api/v1/json/compare1 crédito(s)

Comparar JSON. Exige o escopo json:compare.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "left": {
        "nome": "AtalhoLab",
        "versao": 1
    },
    "right": {
        "nome": "AtalhoLab",
        "versao": 2
    }
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/json/compare" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"left":{"nome":"AtalhoLab","versao":1},"right":{"nome":"AtalhoLab","versao":2}}'
POST/api/v1/json/to-csv2 crédito(s)

Converter JSON para CSV. Exige o escopo json:to-csv.

Lote máximo
1000
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "json": [
        {
            "nome": "Ana",
            "idade": 30
        },
        {
            "nome": "Bruno",
            "idade": 28
        }
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/json/to-csv" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"json":[{"nome":"Ana","idade":30},{"nome":"Bruno","idade":28}]}'
POST/api/v1/csv/to-json2 crédito(s)

Converter CSV para JSON. Exige o escopo csv:to-json.

Lote máximo
1000
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "csv": "nome,idade\nAna,30\nBruno,28",
    "delimiter": ","
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/csv/to-json" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"csv":"nome,idade\nAna,30\nBruno,28","delimiter":","}'
POST/api/v1/timestamp/convert1 crédito(s)

Converter timestamp. Exige o escopo timestamp:convert.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "value": "now",
    "unit": "seconds"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/timestamp/convert" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"value":"now","unit":"seconds"}'
POST/api/v1/base64/process1 crédito(s)

Codificar ou decodificar Base64. Exige o escopo base64:process.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "operation": "encode",
    "value": "AtalhoLab"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/base64/process" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"operation":"encode","value":"AtalhoLab"}'
POST/api/v1/url/process1 crédito(s)

Codificar ou decodificar URL. Exige o escopo url:process.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "operation": "encode",
    "value": "atalhos rápidos"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/url/process" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"operation":"encode","value":"atalhos rápidos"}'
POST/api/v1/hash/generate1 crédito(s)

Gerar hash. Exige o escopo hash:generate.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "algorithm": "sha256",
    "items": [
        "AtalhoLab"
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/hash/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"algorithm":"sha256","items":["AtalhoLab"]}'
POST/api/v1/password/generate1 crédito(s)

Gerar senha segura. Exige o escopo password:generate.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "quantity": 2,
    "length": 16
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/password/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity":2,"length":16}'
POST/api/v1/slug/generate1 crédito(s)

Gerar slug. Exige o escopo slug:generate.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "items": [
        "Ferramentas rápidas online"
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/slug/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"items":["Ferramentas rápidas online"]}'
POST/api/v1/average/calculate1 crédito(s)

Calcular média. Exige o escopo average:calculate.

Lote máximo
1000
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "values": [
        7.5,
        8,
        9
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/average/calculate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"values":[7.5,8,9]}'
POST/api/v1/age/calculate1 crédito(s)

Calcular idade. Exige o escopo age:calculate.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "birth_date": "1990-05-20",
    "at_date": "2026-07-31"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/age/calculate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"birth_date":"1990-05-20","at_date":"2026-07-31"}'
POST/api/v1/marketing/utm1 crédito(s)

Gerar URL com UTM. Exige o escopo marketing:utm.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "url": "https://exemplo.com/produto",
    "source": "google",
    "medium": "cpc",
    "campaign": "lancamento"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/marketing/utm" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://exemplo.com/produto","source":"google","medium":"cpc","campaign":"lancamento"}'
POST/api/v1/url/analyze1 crédito(s)

Analisar URL. Exige o escopo url:analyze.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "url": "https://exemplo.com:443/pagina?q=teste#secao"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/url/analyze" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://exemplo.com:443/pagina?q=teste#secao"}'
POST/api/v1/seo/serp-preview1 crédito(s)

Gerar prévia SERP. Exige o escopo seo:serp-preview.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "title": "AtalhoLab",
    "url": "https://exemplo.com",
    "description": "Descrição da página."
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/seo/serp-preview" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"title":"AtalhoLab","url":"https://exemplo.com","description":"Descrição da página."}'
POST/api/v1/seo/title-count1 crédito(s)

Analisar título SEO. Exige o escopo seo:title-count.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Ferramentas online gratuitas"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/seo/title-count" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Ferramentas online gratuitas"}'
POST/api/v1/seo/description-count1 crédito(s)

Analisar meta description. Exige o escopo seo:description-count.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Ferramentas gratuitas para tarefas do dia a dia."
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/seo/description-count" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Ferramentas gratuitas para tarefas do dia a dia."}'
POST/api/v1/robots/generate1 crédito(s)

Gerar robots.txt. Exige o escopo robots:generate.

Lote máximo
500
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "policy": "custom",
    "paths": [
        "/admin/"
    ],
    "sitemap": "https://exemplo.com/sitemap.xml"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/robots/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"policy":"custom","paths":["/admin/"],"sitemap":"https://exemplo.com/sitemap.xml"}'
POST/api/v1/sitemap/generate1 crédito(s)

Gerar Sitemap XML. Exige o escopo sitemap:generate.

Lote máximo
500
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "urls": [
        "https://exemplo.com/",
        "https://exemplo.com/sobre"
    ],
    "frequency": "weekly"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/sitemap/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://exemplo.com/","https://exemplo.com/sobre"],"frequency":"weekly"}'
POST/api/v1/schema/faq1 crédito(s)

Gerar FAQ Schema. Exige o escopo schema:faq.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "items": [
        {
            "question": "Como funciona?",
            "answer": "Envie perguntas e respostas."
        }
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/schema/faq" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"question":"Como funciona?","answer":"Envie perguntas e respostas."}]}'
POST/api/v1/domain/extract1 crédito(s)

Extrair domínios. Exige o escopo domain:extract.

Lote máximo
500
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "urls": [
        "https://www.exemplo.com/a",
        "https://sub.dominio.com.br/b"
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/domain/extract" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://www.exemplo.com/a","https://sub.dominio.com.br/b"]}'
POST/api/v1/business/margin-markup1 crédito(s)

Calcular margem e markup. Exige o escopo business:margin-markup.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "cost": 50,
    "price": 100
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/margin-markup" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"cost":50,"price":100}'
POST/api/v1/business/sale-price1 crédito(s)

Calcular preço de venda. Exige o escopo business:sale-price.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "cost": 50,
    "variable_expenses_percent": 10,
    "desired_margin_percent": 20
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/sale-price" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"cost":50,"variable_expenses_percent":10,"desired_margin_percent":20}'
POST/api/v1/business/commission1 crédito(s)

Calcular comissão. Exige o escopo business:commission.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "sales": 10000,
    "rate_percent": 5
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/commission" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"sales":10000,"rate_percent":5}'
POST/api/v1/business/simple-interest1 crédito(s)

Calcular juros simples. Exige o escopo business:simple-interest.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "principal": 1000,
    "rate_percent": 2,
    "periods": 12
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/simple-interest" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"principal":1000,"rate_percent":2,"periods":12}'
POST/api/v1/business/compound-interest1 crédito(s)

Calcular juros compostos. Exige o escopo business:compound-interest.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "principal": 1000,
    "rate_percent": 2,
    "periods": 12
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/compound-interest" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"principal":1000,"rate_percent":2,"periods":12}'
POST/api/v1/business/installment1 crédito(s)

Calcular parcelamento. Exige o escopo business:installment.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "principal": 1000,
    "rate_percent": 1.5,
    "installments": 12
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/installment" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"principal":1000,"rate_percent":1.5,"installments":12}'
POST/api/v1/business/roi1 crédito(s)

Calcular ROI. Exige o escopo business:roi.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "gain": 15000,
    "investment": 10000
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/roi" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"gain":15000,"investment":10000}'
POST/api/v1/business/cac1 crédito(s)

Calcular CAC. Exige o escopo business:cac.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "acquisition_investment": 5000,
    "new_customers": 100
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/cac" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"acquisition_investment":5000,"new_customers":100}'
POST/api/v1/business/ltv1 crédito(s)

Calcular LTV. Exige o escopo business:ltv.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "average_ticket": 100,
    "purchases_per_period": 2,
    "retention_periods": 12,
    "gross_margin_percent": 60
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/ltv" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"average_ticket":100,"purchases_per_period":2,"retention_periods":12,"gross_margin_percent":60}'
POST/api/v1/business/break-even1 crédito(s)

Calcular ponto de equilíbrio. Exige o escopo business:break-even.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "fixed_costs": 10000,
    "unit_price": 100,
    "unit_variable_cost": 40
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/break-even" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"fixed_costs":10000,"unit_price":100,"unit_variable_cost":40}'
POST/api/v1/business/average-ticket1 crédito(s)

Calcular ticket médio. Exige o escopo business:average-ticket.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "revenue": 10000,
    "sales": 80
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/average-ticket" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"revenue":10000,"sales":80}'
POST/api/v1/business/churn1 crédito(s)

Calcular churn. Exige o escopo business:churn.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "lost_customers": 20,
    "initial_customers": 500
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/churn" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"lost_customers":20,"initial_customers":500}'
POST/api/v1/business/conversion-rate1 crédito(s)

Calcular taxa de conversão. Exige o escopo business:conversion-rate.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "conversions": 50,
    "opportunities": 1000
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/conversion-rate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"conversions":50,"opportunities":1000}'
POST/api/v1/business/cpm1 crédito(s)

Calcular CPM. Exige o escopo business:cpm.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "investment": 500,
    "impressions": 100000
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/cpm" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"investment":500,"impressions":100000}'
POST/api/v1/business/cpc1 crédito(s)

Calcular CPC. Exige o escopo business:cpc.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "investment": 500,
    "clicks": 1200
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/cpc" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"investment":500,"clicks":1200}'
POST/api/v1/business/cpa1 crédito(s)

Calcular CPA. Exige o escopo business:cpa.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "investment": 500,
    "acquisitions": 25
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/cpa" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"investment":500,"acquisitions":25}'
POST/api/v1/business/roas1 crédito(s)

Calcular ROAS. Exige o escopo business:roas.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "attributed_revenue": 5000,
    "investment": 1000
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/roas" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"attributed_revenue":5000,"investment":1000}'
POST/api/v1/business/profit1 crédito(s)

Calcular lucro. Exige o escopo business:profit.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "revenue": 10000,
    "costs": 6500
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/profit" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"revenue":10000,"costs":6500}'
POST/api/v1/business/contribution-margin1 crédito(s)

Calcular margem de contribuição. Exige o escopo business:contribution-margin.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "price": 100,
    "variable_costs": 35,
    "variable_expenses": 15
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/contribution-margin" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"price":100,"variable_costs":35,"variable_expenses":15}'
POST/api/v1/business/successive-discounts1 crédito(s)

Calcular descontos sucessivos. Exige o escopo business:successive-discounts.

Lote máximo
100
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "initial_value": 100,
    "discounts_percent": [
        10,
        20
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/successive-discounts" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"initial_value":100,"discounts_percent":[10,20]}'
POST/api/v1/business/percentage-variation1 crédito(s)

Calcular variação percentual. Exige o escopo business:percentage-variation.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "initial_value": 100,
    "final_value": 125
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/percentage-variation" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"initial_value":100,"final_value":125}'
POST/api/v1/business/pro-rata1 crédito(s)

Calcular valor pro rata. Exige o escopo business:pro-rata.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "full_value": 300,
    "used_days": 10,
    "period_days": 30
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/business/pro-rata" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"full_value":300,"used_days":10,"period_days":30}'
POST/api/v1/text/reverse1 crédito(s)

Inverter texto. Exige o escopo text:reverse.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "AtalhoLab",
    "mode": "characters"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/reverse" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"AtalhoLab","mode":"characters"}'
POST/api/v1/text/shuffle-lines1 crédito(s)

Embaralhar linhas. Exige o escopo text:shuffle-lines.

Lote máximo
500
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "lines": [
        "Ana",
        "Bruno",
        "Carla"
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/shuffle-lines" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"lines":["Ana","Bruno","Carla"]}'
POST/api/v1/text/number-lines1 crédito(s)

Numerar linhas. Exige o escopo text:number-lines.

Lote máximo
1000
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "lines": [
        "primeira",
        "segunda"
    ],
    "start": 1
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/number-lines" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"lines":["primeira","segunda"],"start":1}'
POST/api/v1/text/affix-lines1 crédito(s)

Adicionar prefixo e sufixo. Exige o escopo text:affix-lines.

Lote máximo
1000
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "lines": [
        "a",
        "b"
    ],
    "prefix": "[",
    "suffix": "]"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/affix-lines" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"lines":["a","b"],"prefix":"[","suffix":"]"}'
POST/api/v1/text/extract-emails1 crédito(s)

Extrair e-mails. Exige o escopo text:extract-emails.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Contato: ana@example.com e bruno@example.com"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/extract-emails" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Contato: ana@example.com e bruno@example.com"}'
POST/api/v1/text/extract-urls1 crédito(s)

Extrair URLs. Exige o escopo text:extract-urls.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Veja https://exemplo.com e https://atalholab.com.br"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/extract-urls" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Veja https://exemplo.com e https://atalholab.com.br"}'
POST/api/v1/text/extract-numbers1 crédito(s)

Extrair números. Exige o escopo text:extract-numbers.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Pedidos 10, 20 e 35.5"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/extract-numbers" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Pedidos 10, 20 e 35.5"}'
POST/api/v1/text/normalize-spaces1 crédito(s)

Normalizar espaços. Exige o escopo text:normalize-spaces.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Texto   com  espaços\n\n\nextras"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/normalize-spaces" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Texto   com  espaços\n\n\nextras"}'
POST/api/v1/text/mask-data1 crédito(s)

Mascarar dados. Exige o escopo text:mask-data.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "ana@example.com 529.982.247-25"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/mask-data" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"ana@example.com 529.982.247-25"}'
POST/api/v1/text/lorem1 crédito(s)

Gerar Lorem Ipsum. Exige o escopo text:lorem.

Lote máximo
50
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "paragraphs": 3
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/lorem" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"paragraphs":3}'
POST/api/v1/text/username1 crédito(s)

Gerar nomes de usuário. Exige o escopo text:username.

Lote máximo
50
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "words": "Maria Silva",
    "quantity": 10
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/username" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"words":"Maria Silva","quantity":10}'
POST/api/v1/text/case-identifier1 crédito(s)

Converter identificador. Exige o escopo text:case-identifier.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "Meu Campo Exemplo",
    "mode": "snake"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/case-identifier" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"Meu Campo Exemplo","mode":"snake"}'
POST/api/v1/text/html-escape1 crédito(s)

Escapar HTML. Exige o escopo text:html-escape.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "<strong>Teste</strong>"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/html-escape" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"<strong>Teste</strong>"}'
POST/api/v1/text/html-unescape1 crédito(s)

Desescapar HTML. Exige o escopo text:html-unescape.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "text": "&lt;strong&gt;Teste&lt;/strong&gt;"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/html-unescape" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"text":"&lt;strong&gt;Teste&lt;/strong&gt;"}'
POST/api/v1/text/markdown-table1 crédito(s)

Gerar tabela Markdown. Exige o escopo text:markdown-table.

Lote máximo
1000
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "rows": [
        [
            "Nome",
            "Idade"
        ],
        [
            "Ana",
            "30"
        ]
    ]
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/text/markdown-table" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"rows":[["Nome","Idade"],["Ana","30"]]}'
POST/api/v1/network/ipv4-subnet1 crédito(s)

Calcular sub-rede IPv4. Exige o escopo network:ipv4-subnet.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "cidr": "192.168.1.10/24"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/network/ipv4-subnet" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"cidr":"192.168.1.10/24"}'
POST/api/v1/network/ipv4-decimal1 crédito(s)

Converter IPv4 e decimal. Exige o escopo network:ipv4-decimal.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "value": "192.168.1.1"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/network/ipv4-decimal" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"value":"192.168.1.1"}'
POST/api/v1/jwt/decode1 crédito(s)

Decodificar JWT. Exige o escopo jwt:decode.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "token": "eyJhbGciOiJub25lIn0.eyJzdWIiOiJ0ZXN0ZSJ9."
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/jwt/decode" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"token":"eyJhbGciOiJub25lIn0.eyJzdWIiOiJ0ZXN0ZSJ9."}'
POST/api/v1/query/build1 crédito(s)

Gerar query string. Exige o escopo query:build.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "params": {
        "q": "atalhos",
        "page": 2
    }
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/query/build" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"params":{"q":"atalhos","page":2}}'
POST/api/v1/query/parse1 crédito(s)

Ler query string. Exige o escopo query:parse.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "query": "?q=atalhos&page=2"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/query/parse" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"query":"?q=atalhos&page=2"}'
POST/api/v1/html/minify1 crédito(s)

Minificar HTML. Exige o escopo html:minify.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "html": "<div>  Teste  </div>"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/html/minify" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"html":"<div>  Teste  </div>"}'
POST/api/v1/css/minify1 crédito(s)

Minificar CSS. Exige o escopo css:minify.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "css": "body { color: red; }"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/css/minify" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"css":"body { color: red; }"}'
POST/api/v1/color/convert1 crédito(s)

Converter HEX, RGB e HSL. Exige o escopo color:convert.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "color": "#4f46e5"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/color/convert" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"color":"#4f46e5"}'
POST/api/v1/color/contrast1 crédito(s)

Verificar contraste de cores. Exige o escopo color:contrast.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "foreground": "#0f172a",
    "background": "#ffffff"
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/color/contrast" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"foreground":"#0f172a","background":"#ffffff"}'
POST/api/v1/bytes/convert1 crédito(s)

Converter bytes. Exige o escopo bytes:convert.

Lote máximo
1
Rate limit
60/min
Resposta
JSON padronizado

Payload de exemplo

{
    "value": 10,
    "unit": "MB",
    "base": 1024
}

Exemplo cURL

curl -X POST "https://atalholab.com.br/api/v1/bytes/convert" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"value":10,"unit":"MB","base":1024}'
Parâmetros comuns

quantity define a quantidade; formatted controla pontuação; state restringe CPF por UF; alphanumeric alterna CNPJ numérico/alfanumérico; type, count e format controlam lotes.

05

Respostas, créditos e limites

O corpo e os headers permitem rastrear cada chamada.

Contrato de sucesso

{
  "success": true,
  "data": { "items": [] },
  "error": null,
  "meta": {
    "request_id": "uuid",
    "timestamp": "ISO-8601",
    "credits": { "cost": 1, "remaining": 999 }
  }
}

Headers informativos

  • X-Request-IDRastreamento
  • X-Credits-CostCusto confirmado
  • X-Credits-RemainingSaldo restante
  • X-RateLimit-LimitLimite da janela
  • X-RateLimit-RemainingChamadas restantes
  • X-RateLimit-ResetFim da janela
06

Erros

Falhas de validação e servidor não consomem créditos.

400Requisição inválida
401Chave inválida
402Saldo insuficiente
403Escopo, IP ou origem
409Idempotência repetida
422Entrada rejeitada
429Limite excedido
500Erro interno sem detalhes
07

Exemplos de uso

Substitua SUA_CHAVE por uma variável de ambiente segura.

cURL
curl -X POST "https://atalholab.com.br/api/v1/uuid/generate" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"quantity": 3}'
PHP
$response = file_get_contents(
  'https://atalholab.com.br/api/v1/uuid/generate',
  false,
  stream_context_create(['http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer {$apiKey}\r\nContent-Type: application/json",
    'content' => json_encode(['quantity' => 3]),
  ]])
);
JavaScript
const response = await fetch('/api/v1/cpf/validate', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ cpf: '529.982.247-25' })
});
const result = await response.json();
Python
response = requests.post(
    'https://atalholab.com.br/api/v1/cnpj/generate',
    headers={'Authorization': f'Bearer {api_key}'},
    json={'quantity': 1, 'alphanumeric': False},
)
08

Versionamento e changelog

Mudanças incompatíveis exigem uma nova versão na URL.

v1 — catálogo ampliado

78 operações, carteira global por usuário, projetos, chaves, créditos avulsos, rate limit, idempotência, painel e OpenAPI.

Correções compatíveis permanecem em /api/v1. Consulte também a especificação OpenAPI em JSON.