Esta página foi traduzida pela API Cloud Translation.

Comece a usar a API Apigee

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

A API Apigee pode ser usada para desenvolver e gerir APIs programaticamente com um conjunto de operações RESTful.

Pode usar a API Apigee para integrar a gestão de proxies de API no ciclo de vida de desenvolvimento de software (SDLC) da sua organização. Uma utilização comum da API Apigee é escrever scripts ou código que implementam proxies de API ou que migram proxies de API de um ambiente para outro, como parte de um processo automatizado maior que também implementa ou migra outras aplicações.

Para mais informações, consulte a API Apigee.

Ativar a API Apigee

Certifique-se de que ativou a API Apigee. A forma mais simples de ativar uma API para o seu projeto é usar a Google Cloud consola. Para ver todos os detalhes, consulte o Passo 1: ative as APIs.

Obter uma chave de acesso OAuth 2.0

A API Apigee suporta o OAuth 2.0 para autenticação de utilizadores. Com o OAuth 2.0, troca as suas credenciais do Google Cloud por um token de acesso que pode usar para fazer chamadas seguras para a API Apigee. Depois de obter um token, não tem de trocar novamente as suas credenciais até o token expirar.

Obtenha um token através das credenciais do Google Cloud

Para obter um token através das suas credenciais do Google Cloud:

Autorize o gcloud a aceder à Cloud Platform com as suas credenciais de utilizador Google:
```
gcloud auth login
```
Obtenha um token para a conta atualmente ativa:
```
export TOKEN=$(gcloud auth print-access-token)
```
Quando chama uma API Apigee, transmite a chave de acesso no cabeçalho de autorização. Por exemplo:
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"
```

Obtenha um token através de uma chave de conta de serviço do Google Cloud

Para obter um token através de uma chave de conta de serviço para autorização:

Gere uma chave para a sua conta de serviço através da Google Cloud consola, conforme descrito no artigo Criar e gerir chaves de contas de serviço.
É transferido para o seu computador um ficheiro JSON que contém as credenciais da conta de serviço.
Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS para o caminho onde se encontra a chave da conta de serviço:
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```

Quando chama uma API Apigee, use a Google Cloud CLI para adicionar um token de acesso ao cabeçalho de autorização. Por exemplo:

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

Definir variáveis de ambiente para pedidos de API Apigee

Os exemplos da API Apigee e da CLI gcloud fornecidos ao longo da documentação usam uma ou mais das variáveis de ambiente definidas na tabela seguinte.

Ao definir as variáveis de ambiente antecipadamente para valores significativos no seu ambiente, pode copiar e colar os pedidos de exemplo para os executar no seu próprio ambiente com modificações mínimas ou nulas.

Variável de ambiente	Descrição
`$API`	Nome do proxy de API.
`$APIPRODUCT`	Nome do produto API.
`$APP`	ID de uma app.
`$DEVELOPER_EMAIL`	Endereço de email do programador.
`$ENV`	Nome do seu ambiente, como `test` ou `prod`.
`$ID`	ID do recurso.
`$KEY`	Chave de consumidor.
`$NAME`	Nome do recurso.
`$ORG`	A sua organização do Apigee.
`$REV`	Número de revisão do proxy de API.
`$SHAREDFLOW`	Nome do fluxo partilhado.
`$TYPE`	Tipo de recurso.

Usar curl

Os exemplos nesta secção usam curl para demonstrar como desenvolver aplicações com a API Apigee. curl é uma ferramenta de linha de comandos de código aberto para transferir dados com sintaxe de URL, que suporta protocolos comuns, como HTTP e HTTPS.

A tabela seguinte resume as opções da linha de comandos curl usadas nos exemplos.

Opção	Descrição
`-d '{}' --data @filename --data-binary @filename`	Define o corpo do pedido, que pode transmitir diretamente ou especificando um nome de ficheiro.
`-F file=@filename --form file=@filename`	Define dados baseados em formulários que pode transmitir especificando um nome de ficheiro.
`-H --header`	Define um cabeçalho do pedido. Tem de transmitir as seguintes informações no cabeçalho do pedido: Cabeçalho `Authorization`: símbolo do OAuth 2.0 para autenticação do utilizador, conforme descrito em Obter uma chave de acesso do OAuth 2.0. `Content-Type` header: Content type of the request body being sent when creating or updating a resource (POST, PATCH, PUT) using the API.
`-X`	Especifica o tipo de pedido (GET, POST, etc.).

Por exemplo:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

Em que $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0.