Utilizzo dell'API Schematics

Imparare a utilizzare l'API IBM Cloud® Schematics utilizzando un token Identity and Access Management per l'autenticazione.

Per utilizzare l'API IBM Cloud Schematics, devi fornire un token IAM ( IBM Cloud® Identity and Access Management generato con le credenziali IBM Cloud. A seconda del modo con cui ti autentichi con IBM Cloud, puoi scegliere tra le seguenti opzioni per automatizzare la creazione del tuo token IBM Cloud IAM.

1. Crea il tuo token di accesso IBM Cloud IAM.

Il corpo della tua richiesta del token API dipende dal metodo di autenticazione IBM Cloud.

È possibile trovare il token IAM " IBM Cloud " nel campo " access_token " dell'output dell'API. Prendi nota del token IBM Cloud IAM per richiamare ulteriori informazioni di intestazione nei passi successivi.

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

Output di esempio

{
"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. Richiama l'ID account del token con cui stai lavorando.

Sostituisci " <iam_access_token> " con il token IAM ricavato dal campo " access_token " dell'output dell'API ottenuto nel passaggio precedente. Nell'output dell'API, puoi trovare l'ID del tuo account IBM Cloud nel campo resources.metadata.guid.

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

Output di esempio

{
    "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. Genera un nuovo token IBM Cloud IAM che include le tue credenziali IBM Cloud e l'ID account che desideri utilizzare.

Se utilizzi una chiave API IBM Cloud, devi usare l'ID account IBM Cloud per il quale è stata creata la chiave API. Per accedere agli spazi di lavoro Schematics o alle azioni nell'account B, accedere all'account B e creare una chiave API IBM Cloud basata sull'account 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
}

È possibile trovare il token IAM " IBM Cloud " nel campo " access_token " e il token di aggiornamento nel campo " refresh_token " dell'output dell'API.

4. Utilizza l'API Schematics per visualizzare tutti i workspace nel tuo account.

Sintassi per elencare tutti gli spazi di lavoro

    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"}

Sintassi per richiamare le informazioni su uno spazio di lavoro specifico:

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

5. Consulta la documentazione APIIBM Cloud Schematics per un elenco di APIs supportati.

Aggiornamento dei token di accesso IAM di IBM Cloud e acquisizione di nuovi token tramite l'API

Un token di accesso IBM Cloud® Identity and Access Management (IAM) scade dopo un'ora. Per garantire l'accesso all'API IBM Cloud devi aggiornare regolarmente il tuo token di accesso. È possibile seguire la stessa procedura per ottenere un nuovo token.

Prima di iniziare, assicurati di disporre di un token di aggiornamento IAM valido per IBM Cloud o di una chiave API per IBM Cloud che ti consenta di richiedere un nuovo token di accesso.

• Token di aggiornamento: segui le istruzioni riportate nella sezione " Automazione del processo di creazione e gestione dell'area di lavoro con l'API IBM Cloud ".
• Chiave API: recupera la tua IBM Cloud chiave API come indicato di seguito.
  1. Dalla barra dei menu, fai clic su Gestisci > Accesso (IAM).
  2. Fai clic sulla pagina Utenti e quindi seleziona te stesso.
  3. Nel riquadro delle chiavi API, fare clic su Crea una chiave API per l' IBM Cloud.
  4. Immetti un Nome e una Descrizione per la tua chiave API e fai clic su Crea.
  5. Fai clic su Mostra per vedere la chiave API che è stata generata per te.
  6. Copia la chiave API in modo che tu possa utilizzarla per richiamare il tuo nuovo token di accesso IBM Cloud IAM.

Utilizza la seguente procedura se vuoi creare un token IBM Cloud IAM o se vuoi ottenere un nuovo token di aggiornamento.

1. Genera un nuovo token di accesso IBM Cloud IAM utilizzando il token di aggiornamento oppure la chiave API IBM Cloud.

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

Output API di esempio

{
    "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
}

Puoi trovare il tuo nuovo token IAM " IBM Cloud " nel campo " access_token" e il token di aggiornamento nel campo " refresh_token " dell'output dell'API.

2. Continua a lavorare con la documentazione dell'API di IBM Cloud Schematics utilizzando il token ottenuto nel passaggio precedente.