Trabalhando com a API do Schematics

Saiba como usar a API IBM Cloud® Schematics usando um token Identity and Access Management para autenticação.

Para trabalhar com a API do IBM Cloud Schematics, é necessário fornecer um token do IBM Cloud® Identity and Access Management (IAM) gerado com suas credenciais do IBM Cloud. Dependendo da maneira que você autenticar com o IBM Cloud, será possível escolher entre as opções a seguir para automatizar a criação de seu token do IBM Cloud IAM.

1. Crie seu token de acesso do IBM Cloud IAM.

O corpo da solicitação para a solicitação de token da API depende do método de autenticação IBM Cloud.

Você pode encontrar o token IAM do IBM Cloud no campo access_token da saída da sua API. Anote o token do IBM Cloud IAM para recuperar informações adicionais do cabeçalho nas próximas etapas.

POST `https://iam.cloud.ibm.com/identity/token`

Exemplo de saída

{
"access_token": "<iam_access_token>",
"refresh_token": "<iam_refresh_token>",
"uaa_token": "<uaa_token>",
"uaa_refresh_token": "<uaa_refresh_token>",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1493747503
"scope": "ibm openid"
}

2. Recupere o ID da conta do token com o qual você está trabalhando

Substitua <iam_access_token> pelo token do IAM obtido no campo access_token da saída da API na etapa anterior. Na saída da API, você pode encontrar o ID da sua conta do IBM Cloud no campo resources.metadata.guid.

GET https://accounts.cloud.ibm.com/coe/v2/accounts

Exemplo de saída

{
    "next_url": null,
    "total_results": 5,
    "resources": [
        {
            "metadata": {
                "guid": "<account_ID>",
                "url": "/coe/v2/accounts/<account_ID>",
                "created_at": "2020-09-29T02:49:41.842Z",
                "updated_at": "2020-08-16T18:56:00.442Z",
                "anonymousId": "1111a1aa1a1111a1aa11aa11111a1111"
            },
            "entity": {
                "name": "<account_name>",
            }
        }
        ]
}

3. Gere um novo token do IBM Cloud IAM que inclua suas credenciais do IBM Cloud e o ID da conta com a qual deseja trabalhar.

Se você usar uma chave de API do IBM Cloud, deverá usar o ID da conta do IBM Cloud para a qual a chave de API foi criada. Para acessar as áreas de trabalho ou as ações do Schematics na conta B, efetue login na conta B e crie uma chave API do IBM Cloud que é baseada na conta B.

POST https://iam.cloud.ibm.com/identity/token

Example output

{
    "access_token": "<iam_token>",
    "refresh_token": "<iam_refresh_token>",
    "token_type": "Bearer",
    "expires_in": 3600,
    "expiration": 1493747503
}

Você pode encontrar o token IAM “ IBM Cloud ” no campo “ access_token ” e o token de atualização no campo “ refresh_token ” da saída da API.

4. Use a API do Schematics para listar todas as áreas de trabalho em sua conta.

Sintaxe para listar todas as áreas de trabalho

    GET https://schematics.cloud.ibm.com/v1/workspaces/

| Input parameters | Values |
| ----- |  --- |
| Header | `Authorization: bearer <iam_token>`|
{: caption="Input parameters to work with the IBM Cloud Schematics API." caption-side="top"}

Sintaxe para recuperar informações sobre um espaço de trabalho específico:

GET https://schematics.cloud.ibm.com/v1/workspaces/{id}

5. Revise o Documentação da API IBM Cloud Schematics para obter uma lista de APIs suportados

Atualização dos tokens de acesso IAM do IBM Cloud e obtenção de novos tokens por meio da API

Um token de acesso IBM Cloud® Identity and Access Management (IAM) expira após uma hora. Seu token de acesso deve ser atualizado regularmente para garantir o acesso à API do IBM Cloud. Você pode seguir os mesmos passos para obter um novo token.

Antes de começar, certifique-se de ter um token de atualização válido do IAM do IBM Cloud ou uma chave de API do IBM Cloud que possa ser usada para solicitar um novo token de acesso.

• Token de atualização: siga as instruções em Automatizando o processo de criação e gerenciamento da área de trabalho com a API da IBM Cloud.
• Chave da API: Obtenha sua IBM Cloud chave da API da seguinte maneira.
  1. Na barra de menus, clique em Gerenciar > Acessar (IAM).
  2. Clique na página Usuários e, em seguida, selecione você mesmo.
  3. Na área de janela chaves API, clique em Criar uma chave API do IBM Cloud.
  4. Insira um Nome e uma Descrição para sua chave API e clique em Criar.
  5. Clique em Mostrar para ver a chave API que foi gerado para você.
  6. Copie a chave de API para que seja possível usá-la para recuperar seu novo token de acesso do IBM Cloud IAM.

Use as etapas a seguir se você desejar criar um token do IBM Cloud IAM ou se desejar obter um novo token de atualização.

1. Gere um novo token de acesso do IBM Cloud IAM usando o token de atualização ou a chave de API do IBM Cloud.

POST https://iam.cloud.ibm.com/identity/token

Exemplo de saída da API.

{
    "access_token": "<iam_token>",
    "refresh_token": "<iam_refresh_token>",
    "uaa_token": "<uaa_token>",
    "uaa_refresh_token": "<uaa_refresh_token>",
    "token_type": "Bearer",
    "expires_in": 3600,
    "expiration": 1493747503
}

Você pode encontrar seu novo token IAM do IBM Cloud em access_token, e o token de atualização no campo refresh_token da saída da API.

2. Continue trabalhando com a documentação da API do IBM Cloud Schematics usando o token da etapa anterior.