Primeiros passos para usar o portal do Cloud Endpoints

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:

Pré-requisitos

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

Como criar um portal

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 service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com é 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 Cloud na página IAM e administrador > IAM do projeto do Cloud.

  • 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

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 de Referência da API SmartDocs que o Portal do Endpoints gerou a partir do documento da OpenAPI. 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.

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 Salvar.

Como excluir um portal

Para excluir um portal:

  1. No Console do 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: