Documentación de la API

Integre Passly fácilmente en sus aplicaciones con nuestra API REST

URL base

Todas las solicitudes parten de esta URL. Sin clave, sin registro.

120
Solicitudes / 10 min
Sin clave
API pública
v1
Versión de la API
…
Tiempo de respuesta
Producciónhttps://passly.fr/api/v1

Endpoints

Tres puntos de entrada. Despliegue uno para ver sus parámetros, un ejemplo y su respuesta.

Genera una o varias contraseñas seguras según los criterios indicados.

Parámetros

lengthinteger
4-128, por defecto: 16Opcional
countinteger
1-50, por defecto: 1Opcional
formatstring
random, pronounceable, passphraseOpcional
lowercaseboolean
Incluir letras minúsculas (por defecto: true)Opcional
uppercaseboolean
Incluir letras mayúsculas (por defecto: true)Opcional
digitsboolean
Incluir cifras (por defecto: true)Opcional
specialboolean
Incluir caracteres especiales (por defecto: false)Opcional
exclude_similarboolean
Excluir caracteres ambiguos (por defecto: false)Opcional
exclude_customstring
Caracteres adicionales que excluir (≤ 256)Opcional
capitalizeboolean
Pronunciables: poner en mayúscula cada sílaba (por defecto: true)Opcional
include_numbersboolean
Pronunciables: añadir cifras (por defecto: true)Opcional
wordsinteger
Frases de contraseña: 3-10Opcional
separatorstring
Frases de contraseña: separador de palabras (≤ 8)Opcional

Ejemplo de solicitud

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

Respuesta

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

Límite de peticiones

Una cuota por dirección IP protege el servicio. Las cabeceras le indican su situación.

Límite por IP

120 solicitudes cada 10 minutos

Cabeceras de respuesta

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

Error 429

Se devuelve cuando se alcanza el límite. La cabecera Retry-After indica el tiempo de espera.

Códigos de error

Cada error devuelve un JSON de forma constante, con un código utilizable.

400Bad Request

Parámetros no válidos o ausentes

{
    "error": true,
    "message": "La longitud debe estar entre 4 y 128 caracteres",
    "code": "invalid_length"
}
429Too Many Requests

Límite de solicitudes superado

{
    "error": true,
    "message": "Límite de solicitudes alcanzado. Por favor espere 234 segundos",
    "retry_after": 234,
    "reset_at": "2026-01-15T10:35:00.000Z"
}
500Internal Server Error

Error interno del servidor

{
    "error": true,
    "message": "Ocurrió un error. Por favor intente de nuevo."
}
503Service Unavailable

Servicio en mantenimiento

{
    "error": true,
    "message": "El sitio está actualmente en mantenimiento. Por favor intente nuevamente en unos minutos."
}

Códigos devueltos en el campo code

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

Ejemplos de integración

La misma llamada, en el lenguaje que prefiera. Copie, pegue, 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');