Introduction

Inklura is an all-in-one business-management platform. From one admin console, manage.inklura.fr, a tenant runs their point of sale, e-commerce catalog and orders, invoicing and accounting, CRM, helpdesk, SMS and email marketing, SEO, and CMS.

This is the developer documentation. It covers what you need to build on top of Inklura or extend it:

  • Platform API: the tRPC API that exposes the platform's business domains, from products to orders, clients, invoices, and campaigns.
  • Brevo-compatible API: an implementation of part of the Brevo REST API v3 (contacts, transactional email, webhooks), with one key per site; code that uses these endpoints works by changing the base URL and the key.
  • SDK & Framework: the bext PRISM framework and platform SDK that Inklura's own apps are built on (KV, queue, tasks, cache, secrets, relational entities).
  • Integrations: SMS, email/MJML, behavioral journeys, SEO reports, and the helpdesk.
  • Events & Webhooks: scheduled tasks, queue workers, and inbound webhooks from payment, email, and commerce providers.
  • Stock & Ordering: the stock movement ledger, supplier order preparation, and the PrestaShop synchronization.
  • Embedding & SSO: shared login across every *.inklura.fr app, embedding an app in an iframe, and adding a new subdomain.

Step-by-step guides and a reference (CLI, bext.config.toml, changelog) round it out.

How the platform is organised

Inklura is a hosted, multi-tenant platform. A few pieces are worth knowing up front:

  • The console: manage.inklura.fr is the admin app, rendered on the server.
  • The API: the reference API is tRPC, reachable under /api/trpc/* on the same host. Every call is scoped to a tenant and, usually, a site.
  • The apps: SMS Designer, SEO, the mail composer, the POS, and tenant sites are separate PRISM apps served under their own *.inklura.fr domains (or the tenant's own domain). They all share one login.
  • The runtime: every app runs on bext, which routes requests by hostname and renders PRISM apps. The SDK (KV, queue, tasks, secrets, and so on) is available to those apps and authenticates your app with the platform automatically.

Who this is for

You want to… Start at
Read or write Inklura business data from your own service Platform API → Overview
Authenticate a script or server against the API Authentication
Build a new app or tenant site on the platform SDK → Overview
Send SMS or email, run journeys, or generate SEO reports Integrations → Overview
Plug a tool or plugin written for the Brevo API into Inklura Brevo-compatible API
React to payments, inbound email, or run scheduled tasks Events → Overview
Understand how stock and supplier orders are calculated Stock & Ordering
Add a new *.inklura.fr app with shared login Embedding & SSO
Note

Inklura is a private, hosted platform, not a download. These docs describe the live API and the SDK used to build apps that run on the platform. If you only need to read or write data, go to the Platform API.

To continue, head to the Quickstart.