REST Endpoints

The Inklura Platform API is served over tRPC. There is no REST version of it to build against today.

Warning

The platform has a /api/v1 prefix reserved for a REST bridge over tRPC, but it is not a supported public interface: do not build against it. Build your integration on tRPC.

Calling tRPC from any HTTP client

You do not need a tRPC library to use the API. Any HTTP client works:

  • a query is a GET on /api/trpc/<router>.<procedure>, with its input URL-encoded as ?input={"json":<value>};
  • a mutation is a POST to the same path, with the JSON body {"json":<value>};
  • the result is at result.data.json.

See the Overview for complete examples.

Other HTTP routes

Two families of HTTP routes sit outside tRPC and are documented elsewhere:

  • /api/auth/*: the authentication endpoints (OIDC login, invitation acceptance, and related flows). See Authentication.
  • /api/webhooks/*: inbound webhooks from payment, email, and commerce providers. See Webhooks.

These routes have their own contracts.