Configurando um ambiente de API

Antes de poder usar a API Direct Link, você deve configurar seu ambiente.

Pré-requisitos gerais

Configure sua conta para acessar o link direto. Certifique-se de que a conta seja atualizada para uma conta paga.

Pré-requisitos da API

Antes de poder usar a API para interagir com um link direto, você deve obter um token IAM e armazenar o endpoint como uma variável. Verifique também se você tem acesso ao serviço da API IBM Cloud Direct Link.

Os exemplos a seguir usam o terminal global do directlink.cloud.ibm.com.

Etapa 1: armazene sua chave de API como uma variável

Execute o comando a seguir para armazenar a chave de API para sua conta em uma variável de ambiente. Se você não tiver uma chave de API, consulte Criando uma chave de API.

apikey="<YOUR_API_KEY>"

Etapa 2: obter um token do IBM Identity and Access Management (IAM)

Execute o comando a seguir para obter e analisar um token do IAM usando o utilitário de processamento de JSON jq. É possível modificar o comando para usar outra ferramenta de análise ou remover a última parte dele para analisar o token manualmente.

IAM_TOKEN=`curl -k -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --header "Accept: application/json" \
  --data-urlencode "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  --data-urlencode "apikey=$apikey" \
  "https://iam.cloud.ibm.com/identity/token"  |jq -r '(.token_type + " " + .access_token)'`

Para visualizar o token do IAM, execute echo $IAM_TOKEN. O resultado é semelhante ao seguinte:

Bearer <your_token>

O cabeçalho de Autorização espera que o token comece com Bearer. Caso o resultado não inclua Bearer, atualize a variável iam_token para inclui-la. Esses exemplos supõem que Bearer esteja incluído no IAM_TOKEN.

Como o token do IAM expira, a etapa anterior deve ser repetida a cada hora para que o token seja atualizado.

Etapa 3: armazene o terminal de API como uma variável

Execute o comando a seguir para armazenar o terminal da API em uma variável, para poder reutilizá-lo posteriormente em sua sessão.

Terminal público:

directlink_api_endpoint="https://directlink.cloud.ibm.com"

Terminal privado virtual:

directlink_api_endpoint="https://private.directlink.cloud.ibm.com"

Para verificar se a variável foi salva, execute echo $directlink_api_endpoint e certifique-se de que a resposta não esteja vazia.

Etapa 4: armazene a versão da API como uma variável

Toda solicitação de API deve incluir o parâmetro version no formato YYYY-MM-DD``. Execute o comando a seguir para armazenar a data da versão em uma variável para que possa ser reutilizada em sua sessão. Para obter mais informações sobre como definir o parâmetro version , consulte Controle de versões no site Direct Link API.

api_version="2020-03-31"

Para verificar se essa variável foi salva, execute echo $api_version e certifique-se de que a resposta não seja vazia.

Etapa 5: verifique se você tem acesso à API

Se você se deparar com resultados inesperados, inclua a sinalização --verbose (depuração) após o comando curl para obter informações detalhadas de criação de log.

Ligue para a API de Localizaçoes Disponíveis para ver os locais disponíveis para o seu link direto, no formato JSON. Pelo menos um objeto retorna.

Este exemplo lista os locais disponíveis para um gateway Direct Link Dedicated. Para Direct Link Connect, substitua connect por dedicated.
```
curl -X GET "$directlink_api_endpoint/v1/offering_types/dedicated/locations?version=$api_version"   -H "Authorization: $IAM_TOKEN"
```
Chame a API de gateways do List para visualizar todos os links diretos que você já criou na sua conta, no formato JSON.
```
curl -X GET "$directlink_api_endpoint/v1/gateways?version=$api_version"   -H "Authorization: $IAM_TOKEN"
```