Pular para o conteúdo principal

Endpoint

POST https://api.bunny.build/api/v1/random-password/generate

Autenticação

HeaderObrigatórioValor
X-API-KeySimSua chave de API (bun_...)
Content-TypeSimapplication/json

Visão geral

Gere senhas aleatórias criptograficamente seguras sob demanda. O Gerador de Senhas da Bunny permite controlar o comprimento e os conjuntos de caracteres (maiúsculas, minúsculas, números e símbolos) e retorna a senha junto com sua entropia em bits para que você possa aplicar sua própria política de força.

Casos de uso

  • Gerar senhas temporárias para novas contas de usuário
  • Alimentar a UI de sugestão de senhas em fluxos de cadastro
  • Criar tokens de API e chaves secretas seguras
  • Automatizar a geração de credenciais em pipelines DevOps

Detalhes

Comprimento: 4–256 caracteres. A entropia é calculada como log2(charset_size^length). Se nenhum conjunto de caracteres for especificado, letras minúsculas e números são usados por padrão.

Corpo da requisição

CampoTipoObrigatórioDescrição
lengthintegerSimComprimento da senha (ex.: 16)
uppercasebooleanNãoIncluir letras maiúsculas (padrão: true)
lowercasebooleanNãoIncluir letras minúsculas (padrão: true)
numbersbooleanNãoIncluir dígitos (padrão: true)
symbolsbooleanNãoIncluir caracteres especiais (padrão: false)

Exemplo

{
  "length": 16,
  "uppercase": true,
  "lowercase": true,
  "numbers": true,
  "symbols": true
}

Resposta

200 OK

CampoTipoDescrição
passwordstringA senha gerada
lengthintComprimento real da senha
strengthstringForça estimada: weak, fair, strong, very_strong
Exemplo
{
  "password": "aB3$kLm9!Xz2#qRt",
  "length": 16,
  "strength": "very_strong"
}

401 Unauthorized

{
  "detail": "Missing API key. Include X-API-Key header."
}

402 Payment Required

{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}

422 Unprocessable Entity

Parâmetros inválidos.
{
  "detail": "Length must be between 4 and 128"
}

429 Too Many Requests

{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}

Exemplo cURL

curl -X POST https://api.bunny.build/api/v1/random-password/generate \
  -H "X-API-Key: bun_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"length": 16, "uppercase": true, "lowercase": true, "numbers": true, "symbols": true}'