Travailler avec l'API Schematics

Apprenez à utiliser l'API IBM Cloud® Schematics à l'aide d'un jeton Identity and Access Management pour l'authentification.

Pour travailler avec l'API IBM Cloud Schematics, vous devez fournir un jeton IBM Cloud® Identity and Access Management (IAM) qui est généré avec vos informations d'identification IBM Cloud. Selon votre mode d'authentification auprès d'IBM Cloud, vous pouvez choisir parmi les options suivantes pour automatiser la création de votre jeton IBM Cloud IAM.

1. Créez votre jeton d'accès IBM Cloud IAM.

Le corps de demande de votre demande de jeton d'API dépend de la méthode d'authentification IBM Cloud.

Vous trouverez le jeton IAM de IBM Cloud dans le champ access_token de votre sortie API. Notez la valeur du jeton IBM Cloud IAM pour extraire des informations d'en-tête supplémentaires dans les étapes suivantes.

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

Exemple de sortie

{
"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. Extrayez l'ID de compte du jeton que vous utilisez.

Remplacez <iam_access_token> par le jeton IAM récupéré dans le champ access_token de votre sortie API à l'étape précédente. Dans la sortie de votre API, vous pouvez trouver l'ID de votre compte IBM Cloud dans le champ resources.metadata.guid.

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

Exemple de sortie

{
    "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. Générez un nouveau jeton IBM Cloud IAM comprenant vos données d'identification IBM Cloud et l'ID du compte que vous souhaitez utiliser.

Si vous utilisez une clé d'API IBM Cloud, vous devez utiliser l'ID du compte IBM Cloud pour lequel la clé d'API a été créée. Pour accéder aux espaces de travail ou aux actions Schematics du compte B, connectez-vous au compte B et créez une clé d'API IBM Cloud basée sur le compte 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
}

Vous trouverez le jeton IAM de IBM Cloud dans le champ access_token et le jeton de rafraîchissement dans le champ refresh_token de votre sortie API.

4. Utilisez l'API Schematics pour répertorier tous les espaces de travail de votre compte.

Syntaxe pour lister tous les espaces de travail

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

Syntaxe permettant de récupérer des informations sur un espace de travail spécifique :

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

5. Consultez la documentation de l'APIIBM Cloud Schematics pour obtenir la liste des APIs prises en charge.

Actualisation des jetons d'accès à IBM Cloud IAM et obtention de nouveaux jetons à l'aide de l'API

Un jeton d'accès IBM Cloud® Identity and Access Management (IAM) expire au bout d'une heure. Vous devez actualiser régulièrement votre jeton d'accès pour garantir l'accès à l'API IBM Cloud. Vous pouvez suivre les mêmes étapes pour obtenir un nouveau jeton.

Avant de commencer, assurez-vous que vous disposez d'un jeton de rafraîchissement IAM valide ( IBM Cloud ) ou d'une clé API ( IBM Cloud ) que vous pouvez utiliser pour demander un nouveau jeton d'accès.

• Jeton d'actualisation : suivez les instructions de la rubrique Automatisation du processus de création et de gestion d'un espace de travail à l'aide de l'API IBM Cloud.
• Clé API : Récupérez votre IBM Cloud Clé API en procédant comme suit.
  1. Dans la barre de menu, cliquez sur Gérer > Accès (IAM).
  2. Cliquez sur la page Utilisateurs, puis sélectionnez-vous.
  3. Dans la sous-fenêtre desclés d'API, cliquez sur Création d'une clé d'API IBM Cloud.
  4. Entrez un Nom et une Description pour la clé d'API et cliquez sur Créer.
  5. Cliquez sur Afficher pour voir la clé d'API qui a été générée pour vous.
  6. Copiez la clé d'API pour pouvoir l'utiliser pour récupérer votre nouveau jeton d'accès IBM Cloud IAM.

Si vous désirez créer un jeton IBM Cloud IAM ou obtenir un nouveau jeton d'actualisation, procédez comme suit :

1. Générez un nouveau jeton IBM Cloud IAM en utilisant le jeton d'actualisation ou la clé d'API IBM Cloud.

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

Exemple de sortie d'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
}

Vous trouverez votre nouveau jeton IAM IBM Cloud dans le champ access_token, et le jeton de rafraîchissement dans le champ refresh_token de votre sortie API.

2. Continuez à travailler avec la documentation de l'API IBM Cloud Schematics en utilisant le jeton de l'étape précédente.