apihub

Documentation

Two tracks: one for those who use other people’s APIs, one for those who publish their own.

For people calling someone else’s API

Consumer documentation→

How to find an API, start using it, debug your integration and understand the invoice. The addresses and headers in the examples are real: copy them as they are.

  1. 1Getting started
  2. 2Keys: issuing, rotating, leaks
  3. 3Gateway answers, limits and quotas
  4. 4Testing how you handle failure
  5. 5Debugging: the call log and the trace
  6. 6Call chains
  7. 7Event notifications
  8. 8Private and partner APIs
  9. 9Applications, roles and the organisation log
  10. 10The calculator and the request board
  11. 11What the console shows
  12. 12Invoices

For people publishing their own API

Provider documentation→

How to publish an API, connect your upstream, set plans, get paid and not break your consumers’ integrations when you ship an update.

  1. 1Publishing
  2. 2The upstream: what we send and what we do not
  3. 3Visibility and the billing model
  4. 4Versions and breaking changes
  5. 5Plans
  6. 6Debugging and your clients’ data
  7. 7Response cache
  8. 8Streaming calls
  9. 9Observing your API
  10. 10Your own domain
  11. 11Unpublishing, deprecating and deleting
  12. 12Roles in an organisation
  13. 13Money and payouts
  14. 14What to check before publishing

Assembled from the application’s handler table

Platform API reference→

The console’s endpoints: applications, keys, subscriptions, plans, webhooks. Assembled from the code.