Integrations
Connect Apigee
Connect Apigee in Apiable. Enter the connection name, your Apigee Organization, and a Google service account JSON Key, then run Test Connection. Apiable manages API products, developers, and apps on Apigee.
You connect Apigee under Integrations → API Gateways. You give the connection a name, enter your Apigee Organization, and paste a Google service account JSON Key. Then you run Test Connection. The core flow works on Apigee today; some per-key operations do not yet.
Where do you connect Apigee?
Go to Integrations → API Gateways, choose + Add Gateway, and on Select an API Gateway Type pick Apigee, then connect.
- Open Integrations → API Gateways.
- Choose + Add Gateway.
- On Select an API Gateway Type, select Apigee.
- Confirm the selection to open the connect form. The gateway type is shown at the top.
What does each Apigee field mean?
The connect form asks for a name, your organization, and a service account key. The JSON Key is write-only, so Apiable does not show it again after you save.
| Field | What to enter |
|---|---|
| Name | A label for this connection inside Apiable. Required. |
| Organization | Your Apigee organization name. Apiable calls the Apigee management API for this organization. Required. |
| JSON Key (write-only) | The full Google service account JSON key, pasted into the text area. Apiable builds Google credentials from it. Required. |
Apiable uses the JSON Key to request a Google access token scoped to the Cloud Platform, then calls apigee.googleapis.com for your organization.
How do you test and save the Apigee connection?
Fill in all three fields, then click the refresh control labelled Test Connection. Apiable lists your Apigee deployments to confirm the key works. A green check reads passed; a red mark reads failed. Then click Save Changes.
- Enter Name, Organization, and JSON Key. Test Connection stays disabled until all three are filled.
- Click the refresh control to run Test Connection. Apiable builds Google credentials and lists the deployments in your organization as the check.
- Read the result: a green check means the test passed; a red mark means it failed.
- Click Save Changes. The gateway appears on the API Gateways list with its Type, Created, and Edited times.
How do you point the Apigee gateway at an Authorization Server?
Open the saved gateway and go to its Authorization tab. Choose the OAuth handler: Gateway-native only or Authorization Server. Picking Authorization Server reveals a picker of your connected servers.
Gateway-native Apigee issues consumer key and secret credentials through developer apps. The tab also shows a Level 0 API Key section and a Product-level governance pairing mode, then Save Changes. See Authorization Servers.
Where do your Apigee APIs appear after connecting?
They appear when you build a plan. Apiable lists your Apigee API proxies as APIs, and you choose which the plan exposes. The connect form itself only sets up the connection.
When you publish a plan, Apiable creates or updates an Apigee API product for it across the environments its proxies are deployed to. When a consumer subscribes through gateway-native authorization, Apiable creates a developer and a developer app bound to that product, and reads back the app's consumer key and secret. See APIs and coupling and Plans.
What does Apiable support on Apigee today?
The core flow: connect the gateway, sync its API proxies as APIs, and deploy plans as Apigee API products with developer apps. Several per-key operations are not yet implemented on Apigee.
These operations are not yet implemented on Apigee:
- Rotating a subscription's secret.
- Enabling or disabling an individual API key.
- Validating that a plan already exists on the gateway.
- Reading usage per plan or per key from the gateway.
Troubleshooting
Match what you see to the fix.
| What you see | What to do |
|---|---|
| Test Connection is greyed out | One of the three fields is empty. Fill Name, Organization, and JSON Key. |
| Test Connection shows a red mark and failed | Apiable could not list deployments for your organization. Check the Organization name and that the JSON Key is a valid service account key with rights on Apigee. |
| The JSON Key field shows a masked value when you reopen the gateway | JSON Key is write-only and held in AWS Secrets Manager, so the form shows a masked value, not the key. Re-enter it only to change it. |
| Banner: your account does not have a sufficient role to manage gateway integrations | Your role cannot create or edit gateways. Ask an admin for the gateway management role, then reopen the form. |
| The Apigee type shows Coming soon and cannot be picked | Your plan does not include that gateway type. The API Gateways page shows how many gateways your plan allows. |
| Delete is disabled on the gateway's row menu | A plan still uses this gateway. Repoint or remove those plans, then delete the gateway. |
| Secret rotation or per-key enable and disable does nothing | Those per-key operations are not yet implemented on Apigee. Use Amazon API Gateway if you need them. |
Where to next
API Gateways
What a gateway integration does and which types Apiable supports.
APIs and coupling
Pick which of this gateway's APIs a plan exposes.
Authorization Servers
Bind Keycloak or Auth0 so the gateway validates scoped OAuth2 tokens.
Connect AWS API Gateway
The fully implemented gateway path, field by field.