Aller au contenu
AyiID

Référence API

Vue d’ensemble de l’API

Une API REST servie par le moteur AYIiD (Fastify). JSON en entrée et en sortie, jetons JWT, validation stricte des schémas.

Base URL et santé

Toutes les routes sont servies à la racine du moteur. Remplacez la base par l’origine de votre déploiement. Une sonde de santé simple est disponible.

1# Base URL (exemple)
2https://api.ayiid.example
3
4# Sonde de sante
5curl https://api.ayiid.example/health
6# { "status": "ok" }

Environnements

Chaque jeton porte un environnement. Les demandes de vérification et la facturation sont isolées par environnement : SANDBOX (défaut) pour l’intégration, PRODUCTION pour le trafic réel.

Authentification

Les routes protégées attendent un JWT dans l’en-tête Authorization. Le rôle porté par le jeton (verifier, holder, admin) conditionne l’accès. Voir Authentification.

1Authorization: Bearer <accessToken>
2Content-Type: application/json

Erreurs

Les erreurs suivent les codes HTTP standard. Une entrée invalide renvoie 400 (validation), un jeton absent ou invalide 401, un rôle insuffisant 403. Les routes sensibles renvoient un message générique pour ne pas guider un attaquant.

ChampTypeDescription
400Bad RequestCorps ou paramètres invalides (schéma Zod).
401UnauthorizedJeton manquant, invalide ou expiré.
403ForbiddenRôle insuffisant pour la route.
404Not FoundRessource introuvable.
429Too Many RequestsLimitation de débit (routes d’auth notamment).
Localisation
Le moteur est bilingue (FR/EN). L’en-tête de langue de la requête détermine la langue des messages renvoyés.

Domaines