Documentation

Quickstart

Provision a key, make your first authenticated call, and read the response.

This walkthrough takes you from zero to a successful API call in about five minutes.

1. Get access

Browse the Developer Portal catalog and open the API you want to use. If it's an open API, you can request a key immediately. If the producer requires approval, your request lands in their queue and you'll be notified when it's granted.

2. Provision a key

From the API's page, request an API key. The portal creates a Kong consumer scoped to that API and issues you a credential. Treat the key like a password — it grants access under your identity.

3. Make your first call

Send the key with each request. The gateway validates it, applies the API's plugins (rate limits, transformations), and proxies to the upstream service.

curl https://api.internal/v1/orders/8f2a \
  -H "apikey: $API_KEY"

(For an OAuth-configured API you would send Authorization: Bearer $TOKEN instead — the API's catalog page states which style it uses.)

You can also make the first call without leaving the portal: the API's "Try it" console injects a key you pick server-side (you don't paste the raw value, though an API that echoes request headers will show it in the response), lets you add any request headers you need — not only the ones the spec declares — and shows the full request/response.

4. Read the response

A successful call returns 200 OK with a JSON body. Errors follow a consistent shape — see Error handling.

Next steps