Getting Started Using Cloud Endpoints Portal

This page describes how to create a portal and introduces you to the portal user interface. For each task, the minimum required Cloud Identity and Access Management permission or role required to complete the task is provided. For more information about Cloud IAM permissions, see the following:

Prerequisites

This page assumes that you have already:

Creating a portal

Minimum required permissions: Project members granted the Project Editor role have the required serviceusage.services.enable permission.

To create a portal:

  1. In the GCP Console, go to the Endpoints > Developer Portal page.

    Go to the Cloud Endpoints Portal

  2. Select the GCP project that the API is in.
  3. Click Create portal. Generating the portal typically takes between 5 and 10 minutes. When your portal is ready, a URL to it is displayed.

Creating a portal has a few side effects:

  • During portal creation, a service account with the name service-[YOUR_PROJECT_NUMBER]@endpoints-portal.iam.gserviceaccount.com is created with the Role Endpoints Portal Service Agent. You can see this service account in the GCP Console on the IAM & admin > IAM page for your project.

  • When your portal is created, it will use the domain name endpointsportal.[YOUR_PROJECT_ID].cloud.goog. To support this, an SSL/TLS certificate and a public DNS record containing your project ID are created and become searchable in the public Certificate Transparency logs, even though your portal is not publicly accessible.

Viewing the portal for an API

Minimum required permissions:

  • Non-project members (the people who will be using your API) must have the Service Management > Service Consumer role. See Controlling Who Can Enable Your API for more information.
  • Project members granted the Project Viewer role have the required servicemanagement.services.get permission.

To view the portal for an API:

  1. Click the URL in the Portal URL section on the Endpoints > Developer Portal page.
  2. Follow the login prompts to continue to your portal. If you have more than one account, make sure to choose the account that is in the GCP project that the API is in.

    The homepage for your portal is displayed. For convenience, you might want to bookmark this URL. The portal homepage displays a list with links to all the APIs in the project.

  3. Click the API that you want to explore. The homepage for the API is displayed.

Introducing the portal UI

At the bottom of the homepage for your API, you will see the following icons that provide useful links for your API users.

  • The API Reference link displays the first page of the API Reference documentation that Cloud Endpoints Portal generated from your OpenAPI document. You can use the navigation bar on the left to view the documentation for each method and resource.

  • The Getting Started link displays example content in the Getting Started guide. Before you send the portal URL to your API users, you will probably want to customize this documentation to provide information that your API users need to get started using your API in their code. See Adding Custom Documentation for information on how to modify the content in the Getting Started guide.

  • The Get a Key link displays the APIs & Services > API Library page in the Developers Console so that users can enable your API in their own GCP projects.

    If your API requires an API key, after users enable your API, they can navigate to the APIs & Services > Credentials page to get an API key that they can use in their code. Before you send the portal URL to your API users, you must grant them access to use your API. See Controlling Who Can Enable Your API for more information.

Customizing the appearance of your portal

You might want to change things such as the color schemes and icon displayed on your portal to match your company's website. By changing the appearance and setting up a custom domain for your portal, you can create a branded experience for your users.

Minimum required permission: Project members granted the Endpoints Portal Admin role or the Project Editor role have the required endpoints.portals.update permission.

To customize the appearance of your portal:

  1. Click Settings settings on the top-right corner of the page.

  2. Click the Site Wide tab. You can change the appearance of the following, as needed:

    • Logo
    • Primary color, which is used as the homepage and title bar background color.
    • Secondary color, which is used as the color for icons and links.
    • Homepage title.
    • Homepage description.
  3. Click Save.

Deleting a portal

Minimum required permissions: Project members granted the Project Editor role have the required serviceusage.services.disable permission.

To delete a portal:

  1. In the GCP Console, go to the Endpoints > Developer Portal page.

    Go to the Cloud Endpoints Portal

  2. Select the GCP project that the API is in.
  3. Click delete Delete Portal.
  4. Click Delete on the confirmation dialog box.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Endpoints with OpenAPI
Need help? Visit our support page.