Vamos começar

Esta página explica como os desenvolvedores podem começar a usar as APIs Cloud de Confiance by S3NS .

Se você estiver usando as APIs Cloud de Confiance pela primeira vez, siga as etapas deste guia para chamar as APIs usando os comandos curl. É possível usar comandos curl para testar uma API antes de desenvolver o aplicativo.

Como criar um projeto do S3NS

Para usar as APIs do Cloud de Confiance , você precisa ter uma conta de usuário (uma conta do S3NS ou de um provedor de identidade externo) e um projeto doS3NS . Um projeto é equivalente a uma conta de desenvolvedor. Ele serve como um contêiner de recursos para seus recursos do Cloud de Confiance . Ele também fornece um limite de isolamento para o uso dos serviços do Cloud de Confiance by S3NS . Assim, você pode gerenciar limites de cota e faturamento de forma independente no nível do projeto. A telemetria e os painéis de uso também são agrupados por projetos. Se você ainda não tiver um projeto, crie um usando o console doCloud de Confiance .

Um projeto pode ter uma ampla variedade de recursos, incluindo chaves de API, clientes OAuth, contas de serviço, VMs do Compute Engine, buckets do Cloud Storage e conjuntos de dados do BigQuery. Quando um aplicativo chama uma API Cloud de Confiance , o projeto que possui as credenciais do aplicativo é chamado de projeto cliente, e o projeto que possui o recurso de destino é chamado de projeto de recurso. Se uma solicitação de API acessar vários recursos, vários projetos de recursos estarão envolvidos.

Se você quiser parar de usar Cloud de Confiance por qualquer motivo, use o console doCloud de Confiance para excluir seu projeto. Seu projeto e todos os recursos no projeto serão excluídos após a janela de retenção. Os diferentes tipos de dados têm períodos de retenção diferentes.

Descoberta de APIs

Antes de usar qualquer API do Cloud de Confiance , use a biblioteca de APIs do console Cloud de Confiance para procurar as APIs doCloud de Confiance disponíveis e descobrir as que melhor atendem às suas necessidades de negócios.

Ativando APIs

Algumas APIs Cloud de Confiance são ativadas por padrão. Para usar uma API Cloud de Confiance que não está ativada por padrão, é necessário ativá-la para seu projeto. Dependendo de quais serviços e projetos estão envolvidos no seu aplicativo, incluindo o projeto do cliente e os projetos de recursos, talvez seja necessário ativar uma API para vários projetos. Quando você ativa uma API que depende de outras APIs, elas também são ativadas ao mesmo tempo.

Para ativar uma API, você precisa aceitar os Termos de Serviço e a responsabilidade de faturamento da API. Você precisa da permissão serviceusage.services.enable no projeto para ativar as APIs. Para mais informações, consulte Controle de acesso do Service Usage.

Para ativar uma API para um projeto usando o console:

  1. Acesse a Cloud de Confiance biblioteca de APIs do console.
  2. Na lista de projetos, selecione o projeto que você quer usar.
  3. Na Biblioteca de APIs, selecione a API que você quer ativar. Se precisar de ajuda para encontrar a API, use o campo de pesquisa e os filtros.
  4. Na página da API, clique em ATIVAR.

Na mesma página, você pode desativar uma API para seu projeto se não usá-la mais para evitar o uso indevido e cobranças acidentais. Também é possível ativar e desativar as APIs do Cloud usando a gcloud CLI e a API Service Usage:

gcloud services enable pubsub.googleapis.com
gcloud services disable pubsub.googleapis.com

Ativar o faturamento

Algumas APIs do Cloud cobram pelo uso. Você precisa ativar o faturamento para seu projeto antes de começar a usar essas APIs no projeto. O uso da API em um projeto é cobrado na conta de faturamento associada ao projeto.

Como autenticar nas APIs

A forma de autenticação em uma API depende do seu ambiente de desenvolvimento e dos métodos de autenticação compatíveis com a API.

Configurar o Application Default Credentials para uso em vários ambientes é a abordagem mais comum e recomendada para a maioria dos aplicativos. Se a API for compatível com chaves de API, essa será outra opção. Se o aplicativo precisar acessar recursos do Cloud de propriedade dos usuários finais, crie um ID do cliente OAuth 2.0 e use as bibliotecas de autenticação.

Para informações gerais sobre autenticação, consulte Autenticação no Google.

Como criar aplicativos

Se você estiver criando um aplicativo usando APIs do Cloud, recomendamos usar as bibliotecas de cliente doCloud de Confiance , se disponíveis. As bibliotecas de cliente podem lidar com recursos comuns da API para sua conveniência, como autenticação, tratamento de erros, repetição e validação de payload. É necessário transmitir as credenciais do aplicativo para as bibliotecas de cliente durante a inicialização, para que as bibliotecas de cliente façam chamadas para as APIs doCloud de Confiance em nome do aplicativo.

Mais informações