Votre application
Le module API relie à un commerce une application que vous faites développer : votre boutique en ligne, votre caisse ou un autre outil. La personne qui la développe trouve tout ce qu'il lui faut dans le guide de l'API. Cette page décrit ce que vous faites, vous, dans Kult Lab.
Rien de ce que l'application envoie n'est appliqué avant que vous ne l'ayez vérifié et activé, partie par partie.
Relier votre application
Nommez-la
Dans l'onglet Intégrations du commerce, ouvrez le module API. Donnez le Nom de l'application, celui que vous lirez partout dans Kult Lab, et son Type d'application : une boutique en ligne, une caisse ou une autre application.
Créez les clés
Créer les clés affiche deux valeurs, KULTLAB_API_KEY et KULTLAB_SIGNING_SECRET.
Copiez-les tout de suite
Copiez les deux valeurs dans le fichier d'environnement de l'application, ou transmettez-les à la personne qui la développe. Elles ne s'afficheront plus. J'ai copié mes clés ferme l'encadré.
La page passe à En attente de votre application, avec l'Adresse de l'API sur laquelle elle s'annonce. Dès sa première annonce, l'application apparaît avec sa version et les parties qu'elle partage, toutes En observation.
Vérifier puis activer chaque partie
La section Liaison regroupe les vérifications communes à toutes les parties : l'application répond, son horloge est à l'heure, ses réponses sont signées. Puis une section par partie que l'application partage : Catalogue, Stock, Ventes, Clients.
Chaque partie passe par trois états :
| État | Ce qu'il veut dire |
|---|---|
| En observation | Ce que l'application envoie pour cette partie est gardé dans le journal sans être appliqué |
| Vérifiée | Toutes ses vérifications ont réussi : Activer apparaît |
| Active | Ce que l'application envoie pour cette partie est appliqué |
Vérifier lance les vérifications de la partie. Le résultat s'affiche dans quelques instants, une ligne par vérification avec une phrase qui dit ce qui a réussi, échoué ou attend encore.
Activer demande une confirmation qui dit ce que la partie va lancer :
| Partie | Ce qu'Activer lance |
|---|---|
| Catalogue | La lecture de tout le catalogue de l'application, qui se tient ensuite à jour à chaque modification |
| Stock | L'application des quantités qu'elle envoie. Vous liez ensuite vos articles et armez l'envoi du stock vous-même. Le stock ne s'active qu'après le catalogue |
| Ventes | L'enregistrement dans vos ventes des commandes envoyées à partir de maintenant |
| Clients | Le lien avec vos fiches des clients déjà connus par leur email ou leur téléphone |
Désactiver remet la partie en observation. Kult Lab rouvre à la vente ce qu'il avait fermé, coupe l'envoi du stock et garde vos liens d'articles.
Les ventes et les clients
Les ventes attendent une vraie commande pour se vérifier : son total, ses prix taxes comprises et un remboursement envoyé. Une commande annulée et payée sans remboursement est signalée sans bloquer. Une fois les ventes actives, la ligne Historique des ventes apparaît, et Importer ajoute les commandes passées avant l'activation (Importer l'historique des ventes).
Activer les clients ne relie que ceux que vous connaissez déjà par leur email ou leur téléphone. Les autres s'importent depuis la page Clients, où vous choisissez lesquels. Un client de l'application complète une fiche sans jamais rien y remplacer.
La vérification de chaque nuit
Kult Lab revérifie chaque nuit les parties actives. Une vérification qui échoue laisse la partie active : la page l'annonce sous la partie avec la pastille Cette nuit, et la barre du bas de votre espace le signale, avec la version de l'application. Prévenez la personne qui la développe.
Renouveler les clés
La section Clés montre le début de la Clé en service, celle que l'application doit utiliser.
Renouveler affiche deux nouvelles valeurs, une seule fois : copiez-les ensemble dans l'application. Les anciennes fonctionnent encore 7 jours, et la carte dit jusqu'à quand. Elle dit aussi si l'application utilise déjà la nouvelle clé.
Révoquer maintenant coupe l'ancienne clé sans attendre les 7 jours. L'application ne parle plus à Kult Lab tant qu'elle n'a pas les nouvelles valeurs.
Lire ce que l'application envoie
Le journal du module montre chaque échange avec l'application, et sa carte Requêtes chacun de ses appels. C'est la page à ouvrir quand la personne qui la développe dit « Kult Lab refuse mes envois ».
Déconnecter l'application
Déconnecter, dans la Zone sensible, rend les deux valeurs inutilisables, l'ancienne comme la nouvelle pendant un renouvellement. L'application garde ses données. Voir Déconnecter un canal.
Retour à la vue d'ensemble des intégrations.