Authentification

L'API Hyperion utilise l'authentification par token Bearer pour identifier les utilisateurs avec des plans premium.

Utilisation

Pour authentifier vos requêtes, incluez votre clé API dans le header Authorization :

curl -H "Authorization: Bearer VOTRE_CLE_API" https://api.sylvain.sh/v6/infos

Vérifier son offre

Utilisez GET /auth pour vérifier le tier auquel un token correspond, ainsi que ses limites :

curl -H "Authorization: Bearer VOTRE_CLE_API" https://api.sylvain.sh/auth

{
    "authenticated": true,
    "tier": "pro",
    "limits": {
        "hourly": 6000,
        "burst": 120
    }
}

Sans token, elle retourne le tier default au lieu d'une erreur :

{
    "authenticated": false,
    "tier": "default",
    "limits": {
        "hourly": 2000,
        "burst": 50
    }
}

Un token invalide retourne la même erreur 401 que ci-dessous.

Limites de requêtes

Plan	Requêtes/heure	Burst/10s
Free	2 000	50
Advanced	3 500	80
Pro	6 000	120
Business	10 000	200

Limite de burst

La limite de burst empêche l'envoi de trop de requêtes dans un court laps de temps. Si vous dépassez la limite de burst, vous recevrez une réponse 429 Too Many Requests.

Voir la page Tarification pour plus de détails.

En-têtes de limite

Chaque réponse porte votre quota courant, ce qui permet à un client de s'auto-réguler au lieu de découvrir sa limite en la dépassant.

En-tête	Description
X-RateLimit-Limit	Nombre de requêtes autorisées dans la fenêtre courante
X-RateLimit-Remaining	Nombre de requêtes restantes dans la fenêtre courante
X-RateLimit-Reset	Moment où la fenêtre est réinitialisée
Retry-After	Secondes à attendre avant de réessayer, envoyé uniquement sur 429

Nouveau en 6.0.0

Ces en-têtes n'existaient pas avant la 6.0.0. Lisez X-RateLimit-Remaining sur chaque réponse et ralentissez à l'approche de zéro, plutôt que d'attendre un 429.

Réponses d'erreur

Token invalide

Si le token fourni est incorrect ou expiré :

{
    "message": "Unauthorized",
    "error": "Invalid token.",
    "status": 401
}

Aucun token

Note

Si aucun token n'est fourni, la requête est traitée comme non authentifiée et utilise les limites de l'offre Gratuit (2 000 requêtes/heure).

Obtenir une clé API

Pour obtenir une clé API, achetez un plan sur la page Tarification. Votre token unique sera envoyé à votre email après l'achat.