Integrations
Connect Apigee
Connect Apigee in Apiable. Enter the connection name, your Apigee Organization and a Google Cloud service account JSON Key, then test the connection. Apiable manages API products, developers and developer apps on Apigee.
You connect Apigee with a Google Cloud service account key. You give the connection a name, enter your Apigee Organization, and paste the service account's JSON Key. Then you run the test and save. The core flow works on Apigee; some per-key operations are Amazon only.
Where do you connect Apigee?
On the Integrations page, choose Set up on the Apigee card. Or open Integrations → API Gateways, choose + Add Gateway, select Apigee on Select API Gateway Type, and click Connect new API Gateway.
The guided setup connects Amazon API Gateway only. If you start Run the wizard as an Apigee customer, its Gateway step shows Apiable doesn't connect Apigee yet. Connect Apigee from its card first. The guided setup then shows Your gateway is already connected, and you continue to the next step.
What does each Apigee field mean?
The connect form asks for a name, your organization and a service account key.
| Field | What to enter |
|---|---|
| Name | A label for this connection inside Apiable. |
| Organization | Your Apigee organization name. Apiable calls the Apigee management API for this organization. |
| JSON Key(write-only) | The full Google Cloud service account JSON key, pasted into the text area. |
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 icon labelled test. Apiable lists the deployments in your Apigee organization to confirm the key works. The result reads Connected or Unsuccessful. Then click Save Changes.
- Enter Name, Organization and JSON Key(write-only). The test stays unavailable until all three are filled.
- Click the refresh icon labelled test. Apiable builds Google credentials and lists the deployments in your organization.
- Read the result: Connected means the test passed; Unsuccessful means it failed.
- Click Save Changes. The gateway appears on the API Gateways list.
If Save Changes stays unavailable after the test reads Connected, contact support@apiable.io to finish connecting the gateway. Do not put the JSON key in the email.
How do you point the Apigee gateway at an Authorization Server?
Open the saved gateway and go to its Authorization tab. Under OAuth handler, choose Gateway-native only or Authorization Server. Picking Authorization Server reveals a picker of your connected servers. Click Save Changes to apply.
With Gateway-native only, Apigee issues consumer key and secret credentials through developer apps. The tab also has the Level 0 API Key section and Product-level governance. See API Gateways and Authorization Servers.
Where do your Apigee APIs appear after connecting?
In Catalog → API Catalog. When you save the connection, Apiable imports your deployed Apigee API proxies as APIs. You then add them to plans.
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, import its API proxies as APIs, and deploy plans as Apigee API products with developer apps. Some per-key operations and gateway reads are available on Amazon API Gateway only.
These are not available on Apigee:
- Enabling or disabling an individual API key.
- Checking that a plan is set up correctly on the gateway.
- Reading usage per plan or per key from the gateway.
- Including only some resources of an API in a plan.
- Pulling API specifications with Gateway Synchronization.
Secret rotation is not available on standard setups for any gateway. To replace a subscription's credentials on Apigee, use Regenerate Credentials: Apiable revokes the current credentials and issues new ones. See Credentials.
Troubleshooting
Match what you see to the fix.
| What you see | What to do |
|---|---|
| The test control is unavailable | One of the three fields is empty. Fill Name, Organization and JSON Key(write-only). |
| The test reads Unsuccessful | Apiable could not list deployments for your organization. Check the Organization name, and that the JSON Key is a complete service account key with rights on Apigee. |
| Save Changes stays unavailable on a new connection | Run the test first. If it reads Connected and Save Changes is still unavailable, contact support@apiable.io to finish connecting the gateway. |
| JSON Key shows a masked value when you reopen the gateway | That is expected. Paste the full JSON key again before you save any change. |
| Calls to Apigee start failing after you edited the gateway | Open the gateway, paste the full JSON key into JSON Key, run the test and click Save Changes. |
| Apiable doesn't connect Apigee yet in the guided setup | The guided setup connects Amazon API Gateway only. Connect Apigee from its card on the Integrations page. |
| Banner: Your account does not currently possess a sufficient role or permissions required to manage gateways. | Your role cannot manage gateways. Ask an Organisation Admin for a role that can, such as Configuration Owner. |
| Delete Gateway cannot be confirmed | A plan still uses this gateway. Remove the gateway from those plans, then delete it. |
Where to next
API Gateways
What a gateway integration does, and what each gateway supports.
APIs and coupling
Add your imported Apigee API proxies to a plan.
Authorization Servers
Connect Keycloak, Auth0 or Duende to issue the OAuth 2.0 tokens your gateway validates.
Connect AWS API Gateway
The gateway with the deepest support, through the guided setup.