Apigee

Access Credentials

This page explains how to obtain access credentials to configure a connection with Apigee:

Creating a Service Account

To create a service account, follow the steps below:

  1. Go to the Google Cloud Platform Console.

  2. In the side menu, click on IAM & Admin > Service accounts.

  3. Fill in the fields to create a service account and click DONE.

details of the service account creation form


Granting Permissions to the Service Account

To grant permissions to the service account, follow the steps below:

Go to the Google Cloud Platform Console and:

  1. In the side menu, click on IAM & Admin > IAM.

  2. Click on GRANT ACCESS.

  3. In the New principals field, select the created service account.

  4. In Assign roles, add the roles “Apigee API Reader” and “Apigee Read-only Admin” and click Save.

steps to grant permissions


Creating the Credentials

To create the credentials, follow the steps below:

Go to the Google Cloud Platform Console and:

  1. In the side menu, click on IAM & Admin > Service accounts.

  2. In the list of service accounts, click on the created account.

  3. In the Keys tab:

    • Click on ADD KEY and

    • Select JSON.

  4. Click on CREATE.
    A JSON file containing the credentials will be downloaded automatically.

steps to create the credentials

Importing APIs

To import APIs manually, follow the steps below:

  1. Open the Connections screen by clicking on the left sidebar menu or on the card on the home screen.

  2. Find the connection you want to edit and click the icon view 2 icon.
    If needed, use the search bar to locate the desired connection.

  3. On the API Imports screen, click the + IMPORT API button, located just below General Info and above API Imports.
    API import screen

  4. Select the APIs you want to import. If needed, use the API name search. Then, click SAVE.

Whenever an API is updated, click refresh icon.
detail with the refresh imported APIs button

Importing OpenAPI/Swagger Contracts

Native connections with the Apigee only import Swagger/OpenAPI files from APIs that have this file manually attached.

This is due to a limitation in Apigee’s own API Manager, which does not offer native OpenAPI generation. This behavior is not a limitation of our solution.

For your API contract to be imported correctly, before importing or synchronizing the API, follow the steps below:

  1. Attach the OpenAPI file to the API Proxy in Apigee at [Proxi Development > API proxy > Develop].
    Apigee screen for attaching resources

  2. If the API already exists in the Sensedia catalog, re-Sync the API by clicking the button to synchronize APIs.
    Highlight of the button to synchronize APIs on the Apigee connections screen

If the API does not exist, proceed normally with the import process.
API import screen

After synchronization/import, check if the contract was imported correctly.

  • When using Adaptive Governance:

    • Access Discovery.

    • In the Actions column, click the icon to view the API.

    • Go to the Documentation tab.

    • See the documentation in the Preview tab.

  • When using the Developer Portal:

    • Access API Docs.

    • In the Actions column, click the icon to view the API.

    • See the documentation in the General Info tab.

imported contract

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]