Primeiros passos para usar o portal do Cloud Endpoints

OpenAPI | gRPC

Em 21 de março de 2022, o Portal do Cloud Endpoints foi descontinuado. O Portal do Cloud Endpoints não estará mais disponível após 21 de março de 2023. O tráfego de API gerenciado pelo Cloud Endpoints não é afetado por essa mudança. Para mais informações, consulte Descontinuação de recursos.

Esta página descreve como criar um portal para o serviço Cloud Endpoints e apresenta a interface do usuário do portal. Para a conclusão de cada tarefa, são fornecidos os papéis mínimos exigidos do Identity and Access Management. Para mais informações sobre as permissões do IAM, consulte o seguinte:

• Como entender os papéis
• Como conceder, alterar e revogar acesso a recursos
• Como criar e gerenciar papéis personalizados

Pré-requisitos

Nesta página, presume-se que você já:

• criou um projeto do Google Cloud;
• criou o arquivo .proto, executou o compilador buffer do protocolo no .proto e gerou o arquivo de configuração do serviço, conforme descrito em Como configurar o Endpoints;
• implantou .pb e os arquivos de configuração de serviço, conforme descrito em Como implantar a configuração do Endpoints.

Como criar um portal

Permissões exigidas para a tarefa

Para executar essa tarefa, é preciso ter serviceusage.services.enable no projeto. O papel Editor do projeto concede essa permissão.

Para criar um portal:

1. No Console do Google Cloud, acesse a página Endpoints > Portal do desenvolvedor.

   Acesse o Portal do Cloud Endpoints

2. Selecione o projeto do Cloud em que está a API.
3. Clique em Criar portal. O portal normalmente leva entre 5 e 10 minutos para ser gerado. Quando ele estiver pronto, um URL será exibido.

O que acontece quando você cria um portal:

• Durante a criação do portal, uma conta de serviço com o nome [e-mail] é criada com o papel Agente de serviço do portal do Endpoints. YOUR_PROJECT_NUMBER é o número do projeto do Cloud. É possível ver essa conta de serviço no Console do Google Cloud na página IAM e administrador > IAM do seu projeto do Cloud.

  Importante: não exclua a conta de serviço do portal do Endpoints e não altere suas permissões porque isso deixa o portal inutilizável Além disso, não atribua o papel Agente de serviço do portal do Endpoints a outros principais.

• Quando o portal é criado, ele usa o nome de domínio endpointsportal.YOUR_PROJECT_ID.cloud.goog. YOUR_PROJECT_ID é seu código do projeto do Cloud. Para dar suporte a isso, um certificado SSL/TLS e um registro de DNS público com o ID do projeto são criados e podem ser pesquisados nos registros públicos de Transparência dos certificados (em inglês), mesmo que o portal não seja de acesso público.

Como visualizar o portal para uma API

Permissões exigidas para a tarefa

Para executar essa tarefa, é necessário ter as permissões a seguir:

• Usuários da API: servicemanagement.services.bind no serviço do Endpoints. O papel Consumidor de serviço contém essa permissão. Consulte Como controlar quem pode ativar a API para mais informações.
• Principais com acesso ao projeto principal do serviço Endpoints servicemanagement.services.get no projeto. O papel Leitor contém essa permissão. Consulte Como conceder, alterar e revogar acesso aos recursos para mais informações.

Para visualizar o portal de uma API:

1. Na página Endpoints > Portal do desenvolvedor, na seção URL do portal, clique no URL.

2. Siga as instruções de login para acessar o portal. Se você tiver mais de uma conta, escolha a conta que está no projeto do Cloud em que a API está localizada.

   A página inicial do seu portal será exibida. Por conveniência, recomendamos que você adicione esse URL aos favoritos. A página inicial do portal exibe uma lista com links para todas as APIs no projeto do Cloud.

3. Clique na API que você quer explorar. A página inicial dela será exibida.

Introdução à IU do portal

Na parte inferior da página inicial da API, os ícones a seguir fornecem links úteis para os usuários da API.

• A Referência da API exibe a primeira página da documentação da referência da API SmartDocs que o portal do Endpoints gerou a partir do arquivo de configuração do serviço. Use a barra de navegação à esquerda para ver a documentação do SmartDocs de cada método e recurso.

• Primeiros passos exibe o conteúdo de exemplo no guia de Primeiros passos. Antes de enviar o URL do portal para os usuários da API, personalize essa documentação para fornecer informações de que os usuários da API precisam para começar a usá-la nos códigos. Para informações sobre como modificar o conteúdo do guia de Primeiros passo, consulte Como adicionar documentação personalizada.

• Conseguir uma chave exibe a página APIs e serviços > Biblioteca de APIs para que os usuários possam ativar a API nos próprios projetos do Google Cloud.

  Se a API exigir uma chave, eles poderão acessar a página APIs e serviços > Credenciais para conseguir uma chave de API que possam usar nos seus próprios códigos depois da ativação. Antes de enviar o URL do portal aos usuários da API, você precisa conceder a eles acesso para usar sua API. Consulte Como controlar quem pode ativar a API para mais informações.

Como personalizar a aparência do seu portal

Altere alguns aspectos como os esquemas de cores e o ícone exibido no portal para combinar com o site da sua empresa. É possível criar uma experiência com sua própria marca para os usuários alterando a aparência e configurando um domínio personalizado para o portal.

Permissões exigidas para a tarefa

Para executar essa tarefa, é preciso ter endpoints.portals.update no projeto. O papel Administrador do portal do Endpoints ou Editor do projeto concedem essa permissão.

Para personalizar a aparência do portal:

1. No canto superior à direita da página, clique em Configurações .

2. Clique na guia Em todo o site. É possível alterar o seguinte:

   • Logotipo
   • Cor primária, que é usada como a cor de fundo da página inicial e da barra de título
   • Cor secundária, que é usada como cor para ícones e links
   • Título da página inicial
   • Descrição da página inicial

3. Clique em Save.

Como excluir um portal

Permissões necessárias para a tarefa

Para executar essa tarefa, é preciso ter serviceusage.services.disable no projeto. O papel Editor do projeto concede essa permissão.

Para excluir um portal:

1. No Console do Google Cloud, acesse a página Endpoints > Portal do desenvolvedor.

   Acesse o Portal do Cloud Endpoints

2. Selecione o projeto do Cloud em que está a API.
3. Clique em Excluir .
4. Na caixa de diálogo de confirmação, clique em Excluir.

A seguir

Saiba mais sobre:

• Campos que o portal do Endpoints usa na sua configuração do Endpoints para gerar a documentação de referência do SmartDocs e como gerar novamente o SmartDocs.
• permissões no papel Administrador do portal do Endpoints;
• como adicionar documentação personalizada ao seu portal.