Introduction
Inklura est une plateforme de gestion d'entreprise tout-en-un. Depuis une seule console d'administration, manage.inklura.fr, un locataire pilote son point de vente, son catalogue et ses commandes e-commerce, sa facturation et sa comptabilité, son CRM, son helpdesk, son marketing SMS et e-mail, son SEO et son CMS.
Vous êtes dans la documentation développeur. Elle couvre ce dont vous avez besoin pour bâtir sur Inklura ou l'étendre :
- API de la plateforme : l'API tRPC qui expose les domaines métier de la plateforme, des produits aux commandes, clients, factures et campagnes.
- API compatible Brevo : une implémentation d'une partie de l'API REST Brevo v3 (contacts, e-mails transactionnels, webhooks), avec une clé par site ; un code qui utilise ces opérations fonctionne en changeant l'URL de base et la clé.
- SDK et Framework : le framework bext PRISM et le SDK de la plateforme, sur lesquels sont bâties les applications d'Inklura elles-mêmes (KV, queue, tâches, cache, secrets, entités relationnelles).
- Intégrations : SMS, e-mail/MJML, parcours comportementaux, rapports SEO et helpdesk.
- Événements et Webhooks : tâches planifiées, workers de queue et webhooks entrants des prestataires de paiement, d'e-mail et de commerce.
- Stock et commandes : le journal de mouvements de stock, la préparation des commandes fournisseurs et la synchronisation avec PrestaShop.
- Embarquement et SSO : la connexion partagée entre toutes les
applications
*.inklura.fr, l'embarquement dans une iframe et l'ajout d'un nouveau sous-domaine.
Des guides pas à pas et une référence (CLI,
bext.config.toml, journal des modifications) complètent l'ensemble.
Comment la plateforme s'organise
Inklura est une plateforme multi-locataire hébergée. Quelques éléments sont utiles à connaître d'emblée :
- La console :
manage.inklura.frest l'application d'administration, rendue côté serveur. - L'API : l'API de référence est tRPC, accessible sous
/api/trpc/*sur le même hôte. Chaque appel est rattaché à un locataire et, le plus souvent, à un site. - Les applications : SMS Designer, SEO, le compositeur de mails, le POS et les sites des
locataires sont des applications PRISM distinctes, servies sous leurs propres domaines
*.inklura.fr(ou le domaine du locataire). Elles partagent toutes une seule connexion. - Le runtime : chaque application tourne sur bext, qui route les requêtes selon le nom d'hôte et effectue le rendu des applications PRISM. Le SDK (KV, queue, tâches, secrets, etc.) est mis à la disposition de ces applications, et authentifie automatiquement votre application auprès de la plateforme.
À qui s'adresse cette documentation
| Vous voulez… | Commencez par |
|---|---|
| Lire ou écrire des données métier Inklura depuis votre propre service | API de la plateforme → Aperçu |
| Authentifier un script ou un serveur auprès de l'API | Authentification |
| Bâtir une nouvelle application ou un site de locataire sur la plateforme | SDK → Aperçu |
| Envoyer des SMS ou des e-mails, exécuter des parcours ou générer des rapports SEO | Intégrations → Aperçu |
| Brancher sur Inklura un outil ou un plugin écrit pour l'API Brevo | API compatible Brevo |
| Réagir aux paiements, aux e-mails entrants, ou exécuter des tâches planifiées | Événements → Aperçu |
| Comprendre comment le stock et les commandes fournisseurs sont calculés | Stock et commandes |
Ajouter une nouvelle application *.inklura.fr avec connexion partagée |
Embarquement et SSO |
Inklura est une plateforme privée et hébergée, pas un logiciel à télécharger. Cette documentation décrit l'API en production et le SDK qui sert à construire des applications exécutées sur la plateforme. Si vous avez seulement besoin de lire ou d'écrire des données, reportez-vous à l'API de la plateforme.
Pour continuer, passez au Démarrage rapide.