Documentazione API

Integra facilmente Passly nelle tue applicazioni con la nostra API REST

URL di base

Tutte le richieste partono da questo URL. Nessuna chiave, nessuna registrazione.

120
Richieste / 10 min
Senza chiave
API pubblica
v1
Versione API
Tempo di risposta
Produzionehttps://passly.fr/api/v1

Endpoint

Tre punti di ingresso. Espandine uno per vederne parametri, esempio e risposta.

Genera una o più password sicure secondo i criteri specificati.

Parametri

lengthinteger
4-128, predefinito: 16Opzionale
countinteger
1-50, predefinito: 1Opzionale
formatstring
random, pronounceable, passphraseOpzionale
lowercaseboolean
Includere le lettere minuscole (predefinito: true)Opzionale
uppercaseboolean
Includere le lettere maiuscole (predefinito: true)Opzionale
digitsboolean
Includere le cifre (predefinito: true)Opzionale
specialboolean
Includere i caratteri speciali (predefinito: false)Opzionale
exclude_similarboolean
Escludere i caratteri ambigui (predefinito: false)Opzionale
exclude_customstring
Caratteri aggiuntivi da escludere (≤ 256)Opzionale
capitalizeboolean
Pronunciabili: rendere maiuscola ogni sillaba (predefinito: true)Opzionale
include_numbersboolean
Pronunciabili: aggiungere cifre (predefinito: true)Opzionale
wordsinteger
Passphrase: 3-10Opzionale
separatorstring
Passphrase: separatore delle parole (≤ 8)Opzionale

Esempio di richiesta

curl -X POST https://passly.fr/api/v1/generate \
  -H "Content-Type: application/json" \
  -d '{
    "length": 20,
    "count": 3,
    "special": true,
    "exclude_similar": true
  }'

Risposta

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"
    }
}

Limitazione delle richieste

Una quota per indirizzo IP protegge il servizio. Le intestazioni indicano a che punto sei.

Limite per IP

120 richieste ogni 10 minuti

Intestazioni di risposta

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset

Errore 429

Restituito quando il limite è raggiunto. L’intestazione Retry-After indica il tempo di attesa.

Codici di errore

Ogni errore restituisce un JSON di forma costante, con un codice utilizzabile.

400Bad Request

Parametri non validi o mancanti

{
    "error": true,
    "message": "La lunghezza deve essere tra 4 e 128 caratteri",
    "code": "invalid_length"
}
429Too Many Requests

Limite di richieste superato

{
    "error": true,
    "message": "Limite di richieste raggiunto. Attendere 234 secondi",
    "retry_after": 234,
    "reset_at": "2026-01-15T10:35:00.000Z"
}
500Internal Server Error

Errore interno del server

{
    "error": true,
    "message": "Si è verificato un errore. Riprova."
}
503Service Unavailable

Servizio in manutenzione

{
    "error": true,
    "message": "Il sito è attualmente in manutenzione. Riprova tra qualche minuto."
}

Codici restituiti nel campo code

  • invalid_length
  • invalid_count
  • invalid_format
  • invalid_words
  • no_charset
  • empty_wordlist

Esempi di integrazione

La stessa chiamata, nel linguaggio che preferisci. Copia, incolla, adatta.

// 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');