Documentation

Documentation

Guides for consuming, producing, and operating APIs on the TenneT API gateway.

Welcome to the API Onboarding Portal documentation. These guides are narrative — conceptual overviews, how-tos, and runbooks. The interactive API reference (per-endpoint schemas and "try it") lives in the Developer Portal, rendered from each API's published spec.

Who this is for

The portal serves three audiences, and the docs are organised the same way:

  • API consumers — developers calling APIs through the gateway. Start with the Quickstart and Authentication.
  • API producers — teams onboarding their service onto the gateway. See Onboarding an API.
  • Platform team — the gateway support team operating Kong and Keycloak. See Introduction.

How the gateway works

Every onboarded service sits behind Kong Gateway. Consumers authenticate once via Keycloak (OIDC) and call any API they're entitled to with a single token or API key. Producers describe their service with an OpenAPI spec; the portal turns that into Kong routes, plugins, and a published catalog entry.

Getting help

Can't find what you need? Each API's owning team is listed on its catalog page in the Developer Portal. For gateway issues, contact the platform team.