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çãohttps://passly.fr/api/v1

Endpoints

Três pontos de entrada. Expanda um para ver os parâmetros, um exemplo e a resposta.

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-Limit
  • X-RateLimit-Remaining
  • X-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_length
  • invalid_count
  • invalid_format
  • invalid_words
  • no_charset
  • empty_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');