Meta — /me, /scopes, /health
Endpoints utilitaires sans scope requis. Source : server/publicApi/routes/meta.ts.
GET /me
Retourne les métadonnées de la clé API courante + utilisation rate limit en temps réel.
Auth
x-api-key requis. Aucun scope nécessaire.
Réponse 200
json
{
"id": 42,
"agencyId": 7,
"scopes": ["clients:read", "invoices:write"],
"rateLimitPerMinute": 60,
"rateLimitPerDay": 10000,
"usage": {
"minuteCount": 3,
"minuteResetAt": "2026-04-27T10:01:00.000Z",
"dayCount": 142,
"dayResetAt": "2026-04-28T00:00:00.000Z"
}
}| Champ | Type | Description |
|---|---|---|
id | int | ID interne de la clé (utilisable côté admin pour révocation) |
agencyId | int | Agence rattachée à la clé |
scopes | string[] | Liste des scopes accordés (peut contenir *) |
rateLimitPerMinute | int | Limite par minute |
rateLimitPerDay | int | Limite par jour |
usage.minuteCount | int | Requêtes consommées dans la fenêtre minute courante |
usage.minuteResetAt | ISO date | Timestamp du prochain reset minute |
usage.dayCount | int | Requêtes consommées dans la fenêtre jour courante |
usage.dayResetAt | ISO date | Timestamp du prochain reset jour |
Cas d'usage
- Pré-vol : vérifier la consommation avant un batch lourd
- Diagnostic : confirmer que la clé est valide et résolue correctement
- Auto-discovery : un client peut découvrir ses scopes au démarrage
Exemple
bash
curl -H "x-api-key: spk_..." https://beta.stormeo.io/api/public/v1/meGET /scopes
Catalogue complet des scopes disponibles pour les clés API. Utile côté UI pour générer un picker.
Auth
x-api-key requis. Aucun scope nécessaire.
Réponse 200
json
{
"scopes": [
"clients:read",
"clients:write",
"clients:delete",
"contacts:read",
"contacts:write",
"contacts:delete",
"websites:read",
"websites:write",
"websites:delete",
"tickets:read",
"tickets:write",
"tickets:delete",
"invoices:read",
"invoices:write",
"quotes:read",
"quotes:write",
"tasks:read",
"tasks:write",
"tasks:delete",
"events:read",
"events:write",
"events:delete",
"webhooks:manage",
"watches:read",
"watches:write",
"*"
]
}Exemple
bash
curl -H "x-api-key: spk_..." https://beta.stormeo.io/api/public/v1/scopesGET /health
Pong de vivacité. Ne révèle aucune info sensible. Utile en healthcheck depuis un orchestrateur (Datadog, Pingdom, UptimeRobot…).
Auth
x-api-key requis (le serveur ne répond pas sans clé valide, pour éviter le scan).
Réponse 200
json
{
"ok": true,
"version": "v1",
"timestamp": "2026-04-27T10:30:00.000Z"
}Exemple
bash
curl -H "x-api-key: spk_..." https://beta.stormeo.io/api/public/v1/health