API & événements
Utilisez l’API REST pour demander ou consulter un état Ormuz, les webhooks sortants pour recevoir les événements plateforme, et les endpoints d’extensions pour faire entrer les signaux d’un provider. Ces surfaces partagent les mêmes objets et événements publics mais répondent à des directions d’échange différentes.
Surfaces machine
| Surface | Direction | Responsabilité |
|---|---|---|
API REST /v1 | Votre système → Ormuz | Créer, lire ou faire évoluer une ressource selon son contrat public ; lancer ou piloter les artefacts exposés par l’API. |
| Webhooks sortants | Ormuz → Votre système | Recevoir les occurrences d’événements plateforme sélectionnées pour un marchand. |
| Webhooks d’extensions | Provider → Ormuz | Recevoir un signal externe selon le contrat de l’extension, puis l’exposer comme événement d’extension sans inventer un fait métier Ormuz. |
Les processus peuvent ensuite consommer les entrées typées des événements qui déclarent une capacité de déclenchement. Un événement provider et un changement canonique Ormuz restent deux faits distincts : le premier peut déclencher un processus qui établira éventuellement le second.
Choisir la bonne surface
| Besoin | Commencez par |
|---|---|
| Créer ou consulter un objet métier | Référence API |
| Authentifier un client machine | Authentification et conventions |
| Être notifié lorsqu’un fait Ormuz se produit | Webhooks sortants |
| Choisir un type d’événement Core | Catalogue des événements |
| Faire entrer un événement Stripe, ERP ou autre provider | Webhooks entrants des extensions |
| Préparer un client aux évolutions de contrat | Versionnement |
Références
Authentification et conventionsClés API, bearer tokens, permission sets, identifiants, metadata, pagination et erreurs.Référence APIContrats REST publics : endpoints, paramètres, corps et réponses.Introduction aux événementsEnveloppe d’un événement, payloads typés et utilisation comme déclencheur.Catalogue des événements plateformeCatalogue exhaustif dérivé du registre public des événements Core.Recevoir des webhooksCréer un endpoint sortant, vérifier les signatures et suivre les tentatives de livraison.Webhooks entrants des extensionsConfigurer le provider pour envoyer ses événements vers l’endpoint déclaré par son extension.Versionnement des contratsFrontière /v1, changements additifs, ruptures et pratiques de compatibilité client.