Vue d'ensemble
L'API Channel branche sur Kult Lab une application que vous écrivez vous-même : une boutique en ligne, une caisse, une plateforme de commande. Elle fait ce que font les modules PrestaShop et Shopcaisse, avec un contrat écrit, appliqué à chaque appel et vérifié avant toute mise en service.
Ce guide s'adresse au développeur de l'application. Le commerçant, lui, crée la connexion, lit les vérifications et active chaque partie depuis Kult Lab.
Trois choses à écrire
| # | Ce que votre application fait | Taille |
|---|---|---|
| 1 | Dire bonjour à chaque déploiement : qui elle est, ce qu'elle sait faire, où la joindre | un POST /hello |
| 2 | Raconter : une file d'envoi qui poste des événements typés quand quelque chose change | un POST /events, chaque type d'événement est facultatif |
| 3 | Répondre : une adresse signée qui reçoit une commande et y répond aussitôt | un point d'entrée, un switch sur le type |
Toutes les requêtes portent la même signature, dans les deux sens.
Cinq parties, activées une par une
Votre application déclare ce qu'elle sait faire sous forme de capacités (catalog.read,
stock.write…). Elles se regroupent en cinq parties :
| Partie | Capacités | Repose sur |
|---|---|---|
| Catalogue | catalog.read | |
| Stock | stock.read, stock.write, stock.restore, product.availability | Catalogue |
| Ventes | orders.read, orders.history | |
| Clients | customers.read, customers.write | |
| Fidélité | loyalty.read, loyalty.write | Clients |
Chaque partie passe par les mêmes quatre étapes, à son rythme :
déclarée → observation → vérifiée → active
(hello) (validé, (toutes les (le commerçant
journalisé, vérifications a cliqué
appliqué réussies) « Activer »)
nulle part)
Tant qu'une partie n'est pas active, ce que vous envoyez est validé et inscrit au journal, et ne touche à aucune donnée du commerce. Le stock peut être actif pendant que les clients restent en observation un mois.
Le parcours
Le commerçant crée la connexion
Il vous transmet deux valeurs, la clé et le secret de signature. Créer la connexion
Votre application dit bonjour
Elle déclare ses capacités et l'adresse de ses commandes. Dire bonjour
Elle envoie ses événements et répond aux commandes
Tout arrive en observation : vous lisez le verdict de chaque événement dans la réponse. Événements, Commandes
Kult Lab vérifie, le commerçant active
Chaque partie a ses vérifications. Toutes réussies, le commerçant l'active. Passer en production
Les références
- Le schéma OpenAPI de chaque opération est servi par l'application à
/api/v1/docs. - Toutes les adresses de ce guide commencent par
https://kult-lab.com/api/v1/channel.