Integrations
Integrations
Integrations connect Apiable to the systems that run your APIs, sign in your users, issue tokens and take payment: API gateways, identity providers, authorization servers and Stripe. You connect them from the Integrations page or through the guided setup.
Integrations connect Apiable to the systems that run your APIs, sign in your users, issue access tokens and take payment. You connect each one once, from the Integrations page or through the guided setup, and then use it across your products and plans.
What can you integrate with Apiable?
Four kinds of system: the API gateway that runs your APIs, the identity provider your users sign in with, the authorization server that issues OAuth 2.0 tokens, and Stripe for payment.
| Integration | What it does | What you can connect |
|---|---|---|
| API Gateways | Runs your APIs. Apiable imports your APIs from it and deploys each subscription to it. | Amazon API Gateway, Azure API Management, Kong, Apigee |
| Identity Providers | Signs people in to your API Portal. | Microsoft Entra ID, Amazon Cognito, OpenID Connect |
| Authorization Servers | Issues the OAuth 2.0 tokens your gateway validates. | Keycloak, Auth0, Duende |
| Payment Providers | Takes payment for paid plans. | Stripe. See Monetization. |
The dashboard sidebar lists Identity Providers as AuthN Providers. Both names point to the same feature. Saving an identity provider sends Apiable a setup request, and Apiable completes the connection on its side. See Identity Providers.
Where do you connect integrations?
Open Integrations → Integrations in the sidebar. The page shows every integration as a card, grouped by category, with its status. The sidebar also has a page per category: API Gateways, AuthN Providers, Authorization Servers and Payment Providers. AuthN Providers and Authorization Servers appear when your plan includes them.
Use the tabs to narrow the grid: All, Available (not connected yet) and Connected. The category chips filter by category, and Clear filters resets both.
Each card shows a status of Connected, Not connected or Error, and one button:
| Card button | What it does |
|---|---|
| Set up | Opens the connect flow for that integration. For Amazon API Gateway this is the guided setup. |
| Configure | Opens the connection's Integration Details view, where Manage integration opens an identity provider's or authorization server's settings. With more than one connection of that type, and for Stripe, it opens the category page instead. To edit an API gateway, open it from Integrations → API Gateways. |
| Review setup | Shown when an authorization server reports an error, or when a Stripe account cannot yet take charges and payouts. Opens the connection so you can fix it. |
| Unlock to use | Shown under Plan upgrade required when your plan does not include the integration. Opens Apiable's contact sales page. |
When a connection needs attention, a banner above the grid reads, for example, 1 integration needs your attention. Expand it to see each connection with a Reconnect button.
What is the guided setup?
A step-by-step setup that walks your technical onboarding in order: Gateway, AuthN, AuthZ and Access Control. Start it with Run the wizard on the Integrations page or the Getting Started page. Once you have progress, the button reads Resume setup.
The guided setup's Gateway step connects Amazon API Gateway. It creates an IAM role in your AWS account and tests it, as described in Connect AWS API Gateway. For Azure API Management, Kong or Apigee, connect the gateway from its card first. The guided setup then shows Your gateway is already connected, and you continue to the next step. See the onboarding plan for how the guided setup fits the rest of your portal setup.
How do identity providers and authorization servers differ?
An identity provider signs people in to your API Portal. An authorization server issues the OAuth 2.0 tokens your gateway validates when an application calls your API. They solve different problems, and you set them up separately.
Which authorization servers can you connect?
Keycloak, Auth0 and Duende. On Select Authorization Server type, Amazon Cognito and Okta carry a Coming Soon tag and cannot be connected yet.
Duende is registration only. Apiable sets a client's scopes when it registers the client, and cannot change those scopes or delete the client afterwards. Plan for that when you decide which server backs which plans. See Authorization Servers.
Where to start
API Gateways
Connect Amazon API Gateway, Azure API Management, Kong or Apigee.
Identity Providers
Connect Microsoft Entra ID, Amazon Cognito or OpenID Connect so people can sign in to your API Portal.
Authorization Servers
Connect Keycloak, Auth0 or Duende to issue the OAuth 2.0 tokens your gateway validates.
Connect Stripe
Connect the payment provider that bills your paid plans.
Onboarding plan
The order to set up your portal, and who owns each step.