Référence API

Retrouvez les principales opérations pour créer, lancer et suivre vos processus, ainsi que les guides pour intégrer l’API Ormuz à vos applications.

Guides détaillés

Quelques ressources métier

Ces pages expliquent les ressources les plus courantes. Elles ne constituent pas une liste exhaustive des routes publiques : le contrat OpenAPI reste la source de vérité pour l'ensemble des endpoints, paramètres et réponses disponibles.

Guide APIEntrepriseCréer, retrouver et qualifier les companies.Guide APIContactsGérer les contacts et leurs coordonnées.Guide APIDossiers d'onboardingOuvrir et suivre les dossiers d’onboarding.Guide APICommandesCréer et faire évoluer les commandes.Guide APIFacturesCréer, émettre et suivre les factures.Guide APILitigesOuvrir et suivre les dossiers de litige.Guide APIPaiementsCréer et suivre les paiements métier.

POST

Exécuter un processus

POST /v1/processes/{id}/runs

Crée une process_instance à partir d'une définition de processus active. Sans option wait, l'appel renvoie immédiatement l'instance créée avec un statut HTTP 201.

Corps de requête

inputobjectoptionnel

Données d'entrée attendues par la définition. Leur structure est validée avant l'exécution.

merchant_idstring | nulloptionnel

Marchand dans lequel exécuter le processus lorsqu'il doit être sélectionné explicitement.

start_sourceobjectoptionnel

Métadonnées de provenance du déclenchement. Ormuz conserve le mode api comme origine de cet appel.

POST + wait

Attendre un résultat synchrone

Ajoutez wait: { timeout_ms } pour attendre le résultat fonctionnel pendant une durée bornée. Si le processus termine dans cette fenêtre, la réponse 200 expose son output. Si le délai est atteint, la réponse 202 conserve l'identifiant de l'instance à suivre ensuite.

Cette option ne transforme pas le moteur en exécution bloquante illimitée : le délai maximal accepté est borné par la configuration publique de la plateforme.

GET

Lire une instance de processus

GET /v1/process-instances/{id}

Renvoie l'état courant d'une process_instance, sa définition, son statut, ses entrées, son éventuel résultat et ses étapes visibles. Utilisez cet endpoint lorsque votre intégration doit relire explicitement l'état d'une exécution.

Pour une orchestration événementielle, privilégiez les webhooks Ormuzplutôt qu'un polling permanent.