Référence API
Les deux API sont décrites en OpenAPI 3.1 dans le dépôt (api/engine.openapi.yaml, api/hub.openapi.yaml) ; ces
spécifications sont écrites avant le code et génèrent les serveurs, les clients et cette référence. La référence interactive
(Scalar) permet d’essayer les appels en direct sur votre poste.
API moteurRuntime d'un workspace : transactions, points, coupons, clients, événements, adaptateur WsOne, management.
API hubGestion : workspaces, offres, coupons, clients, segments, statistiques, sauvegardes, tâches, clés d'API.
Serveurs
Section intitulée « Serveurs »| API | Local | Production |
|---|---|---|
| Moteur (public) | http://localhost:47500 (workspace demo) |
https://<slug>.engine.<domaine> |
| Moteur (management) | http://localhost:47501 |
réseau interne uniquement |
| Hub | http://localhost:47010/v1 |
https://hub.<domaine>/v1 |
Essai en direct
Section intitulée « Essai en direct »- Moteur : dans Scalar, choisissez le serveur local, renseignez l’en-tête
X-Api-Keyavec la clé de démonstration (affichée par le script de seed) puis envoyez un ticket d’exemple. - Hub : obtenez un jeton Keycloak (realm
studioouadmin) et renseignez-le comme jeton Bearer.
L’essai depuis le navigateur suppose que le service appelé autorise l’origine http://localhost:47022 (CORS) ; à défaut, copiez la
commande curl générée par Scalar.
Télécharger les spécifications
Section intitulée « Télécharger les spécifications »- engine.openapi.yaml · engine.json (autonome)
- hub.openapi.yaml · hub.json (autonome)
- Schémas JSON : ticket, offre, résultat d’évaluation
Versionnage
Section intitulée « Versionnage »- Préfixe
/v1. Les ajouts compatibles (champs optionnels, nouveaux points d’accès, nouvelles valeurs d’énumérations documentées comme extensibles) ne changent pas la version. - Un changement incompatible crée
/v2, servi en parallèle au moins 12 mois ; la dépréciation est annoncée par les en-têtesDeprecationetSunset. - Les documents JSON portent
schemaVersion: "1". Les chemins WsOne (/rest/…) sont hors versionnage Remizo. - En-têtes communs :
X-Request-Id(renvoyé),X-Remizo-Engine(instance),Idempotent-Replay,ETag/If-Match. - Pagination par curseur :
cursor+limit(≤ 200), réponse{ items, nextCursor }.