Endpoints REST

L'API de la plateforme Inklura est servie en tRPC. Il n'en existe pas aujourd'hui de version REST sur laquelle bâtir.

Attention

La plateforme réserve un préfixe /api/v1 à un pont REST au-dessus de tRPC, mais ce n'est pas une interface publique prise en charge : ne bâtissez pas dessus. Construisez votre intégration sur tRPC.

Appeler tRPC depuis n'importe quel client HTTP

Vous n'avez pas besoin d'une bibliothèque tRPC pour utiliser l'API. N'importe quel client HTTP convient :

  • une query est un GET sur /api/trpc/<router>.<procedure>, avec son entrée encodée dans l'URL sous la forme ?input={"json":<value>} ;
  • une mutation est un POST sur le même chemin, avec le corps JSON {"json":<value>} ;
  • le résultat se trouve sous result.data.json.

Voir la Vue d'ensemble pour des exemples complets.

Autres routes HTTP

Deux familles de routes HTTP se trouvent en dehors de tRPC et sont documentées ailleurs :

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

Ces routes ont leurs propres contrats.