Endpoints REST

Inklura expose un pont REST à l'adresse /api/v1/<router>/<procedure>, généré à partir des routers tRPC via trpc-to-openapi. Il est partiel et expérimental — la majeure partie de l'API n'est joignable que via tRPC.

Attention

Le pont REST n'est pas un miroir complet de l'API. Construisez sur tRPC, qui est la surface canonique. Ne recourez à REST que pour les quelques procédures listées ci-dessous, et attendez-vous à ce que la couverture évolue.

Le pont /api/v1

Une procédure tRPC apparaît sous /api/v1 uniquement si elle est annotée avec des métadonnées OpenAPI. Aujourd'hui, cette annotation n'existe que sur quelques opérations users et products — ce sont donc les seules procédures actuellement joignables via REST. Tout le reste doit passer par tRPC.

GET https://manage.inklura.fr/api/v1/<router>/<procedure>

L'authentification est la même que pour le reste de l'API — un JWT Bearer plus, en option, les en-têtes de portée locataire/site (voir Sessions et tokens). Les spécifications OpenAPI annoncent bearerAuth avec X-Tenant-ID / X-Site-ID.

Note

Les spécifications OpenAPI générées sont obsolètes — l'ensemble actuel est daté du 2026-05-18. Ne considérez pas une spécification comme une liste faisant autorité de ce qui est en production ; vérifiez auprès de l'endpoint réel.

Portails OpenAPI

Le pont publie plusieurs portails OpenAPI, cloisonnés par audience :

Portail Audience
public Consommateurs généraux/publics
partner Intégrations partenaires
admin Opérations d'administration
internal Usage interne
permissions Surface liée aux permissions

Comme les spécifications sont obsolètes et la couverture partielle, utilisez les portails à des fins d'orientation seulement.

REST écrit à la main, distinct

Deux surfaces REST ne font pas partie du pont tRPC /api/v1 et sont documentées ailleurs :

  • /api/auth/* — les endpoints d'authentification (connexion/callback OIDC, acceptation d'invitation et flux associés). Voir Authentification.
  • /api/webhooks/* — les webhooks entrants provenant des prestataires de paiement, d'e-mail et de commerce. Voir Webhooks.

Ce sont des routes écrites à la main avec leurs propres contrats, indépendantes du générateur tRPC-vers-OpenAPI.

Recommandation

Pour toute nouvelle intégration, utilisez tRPC. Il couvre l'ensemble des ~350 routers et ~6 567 procédures ; le pont REST ne couvre qu'un petit sous-ensemble annoté et ses spécifications sont en retard sur le code.