Documentação da API
Integre facilmente o Passly nas suas aplicações com a nossa API REST
URL de base
Todos os pedidos partem deste URL. Sem chave, sem registo.
120
Pedidos / 10 min
Sem chave
API pública
v1
Versão da API
…
Tempo de resposta
Produção
https://passly.fr/api/v1Endpoints
Três pontos de entrada. Expanda um para ver os parâmetros, um exemplo e a resposta.
Gera uma ou várias palavras-passe seguras segundo os critérios indicados.
Parâmetros
lengthinteger4-128, predefinição: 16Opcional
countinteger1-50, predefinição: 1Opcional
formatstringrandom, pronounceable, passphraseOpcional
lowercasebooleanIncluir letras minúsculas (predefinição: true)Opcional
uppercasebooleanIncluir letras maiúsculas (predefinição: true)Opcional
digitsbooleanIncluir algarismos (predefinição: true)Opcional
specialbooleanIncluir caracteres especiais (predefinição: false)Opcional
exclude_similarbooleanExcluir caracteres ambíguos (predefinição: false)Opcional
exclude_customstringCaracteres adicionais a excluir (≤ 256)Opcional
capitalizebooleanPronunciáveis: capitalizar cada sílaba (predefinição: true)Opcional
include_numbersbooleanPronunciáveis: acrescentar algarismos (predefinição: true)Opcional
wordsintegerFrases-passe: 3-10Opcional
separatorstringFrases-passe: separador das palavras (≤ 8)Opcional
Exemplo de pedido
curl -X POST https://passly.fr/api/v1/generate \
-H "Content-Type: application/json" \
-d '{
"length": 20,
"count": 3,
"special": true,
"exclude_similar": true
}'Resposta
200 OK
{
"success": true,
"data": {
"passwords": [
"K9#mP2$xQr5@nW8&zF3v",
"T4*bN7^gH6%jL3!qR9@m",
"X5&cV8#nB2$kM4@pZ7*w"
],
"entropy_bits": 131.09,
"strength": "very_strong",
"metadata": {
"format": "random",
"length": 20,
"charset_size": 88,
"possible_combinations": 1.7690923e+38,
"possible_combinations_log10": 38.248
},
"crack_time": {
"seconds": 8.8454615e+25,
"formatted": "billions of years",
"unit": "billion_years",
"value": null,
"assumptions": "1e+12 guesses/second"
},
"generated_at": "2026-01-15T10:30:45.000Z",
"locale": "fr",
"api_version": "v1"
}
}Limitação de pedidos
Uma quota por endereço IP protege o serviço. Os cabeçalhos indicam o seu ponto de situação.
Limite por IP
120 pedidos a cada 10 minutos
Cabeçalhos de resposta
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset
Erro 429
Devolvido quando o limite é atingido. O cabeçalho Retry-After indica o tempo de espera.
Códigos de erro
Cada erro devolve um JSON de forma constante, com um código utilizável.
400Bad Request
Parâmetros inválidos ou em falta
{
"error": true,
"message": "O comprimento deve estar entre 4 e 128 caracteres",
"code": "invalid_length"
}429Too Many Requests
Limite de pedidos excedido
{
"error": true,
"message": "Limite de solicitações atingido. Por favor, aguarde 234 segundos",
"retry_after": 234,
"reset_at": "2026-01-15T10:35:00.000Z"
}500Internal Server Error
Erro interno do servidor
{
"error": true,
"message": "Ocorreu um erro. Por favor, tente novamente."
}503Service Unavailable
Serviço em manutenção
{
"error": true,
"message": "O site está atualmente em manutenção. Por favor, tente novamente em alguns minutos."
}Códigos devolvidos no campo code
invalid_lengthinvalid_countinvalid_formatinvalid_wordsno_charsetempty_wordlist
Exemplos de integração
A mesma chamada, na linguagem à sua escolha. Copie, cole, adapte.
// PasslyClient.js
class PasslyClient {
constructor(baseURL = 'https://passly.fr/api/v1') {
this.baseURL = baseURL;
}
async generatePassword(options = {}) {
const response = await fetch(`${this.baseURL}/generate`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
length: options.length || 16,
count: options.count || 1,
lowercase: options.lowercase !== false,
uppercase: options.uppercase !== false,
digits: options.digits !== false,
special: options.special || false,
exclude_similar: options.excludeSimilar || false,
format: options.format || 'random'
})
});
if (!response.ok) {
throw new Error(`API Error: ${response.status}`);
}
return response.json();
}
async checkHealth() {
const response = await fetch(`${this.baseURL}/health`);
return response.json();
}
}
// Utilisation
const passly = new PasslyClient();
const result = await passly.generatePassword({
length: 24,
special: true,
excludeSimilar: true
});
console.log('Mot de passe:', result.data.passwords[0]);
console.log('Force:', result.data.strength);
console.log('Entropie:', result.data.entropy_bits, 'bits');