Cómo trabajar con la API de Schematics

Aprenda a utilizar la API IBM Cloud® Schematics utilizando un token Identity and Access Management para autenticarse.

Para trabajar con la API de « IBM Cloud Schematics », debes proporcionar un token de IAM ( IBM Cloud® Identity and Access Management ) generado con tus credenciales de IBM Cloud. Dependiendo de la forma en que se autentique con IBM Cloud, puede elegir entre las siguientes opciones para automatizar la creación de la señal de IBM Cloud IAM.

1. Cree la señal de acceso de IBM Cloud IAM.

El cuerpo de solicitud para la solicitud de señal de API depende del método de autenticación IBM Cloud.

Puedes encontrar el token IAM de « IBM Cloud » en el campo « access_token » de la salida de tu API. Anote la señal de IBM Cloud IAM para recuperar información de cabecera adicional en los pasos siguientes.

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

Salida de ejemplo

{
"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 el ID de cuenta de la señal con la que está trabajando.

Sustituye « <iam_access_token> » por el token de IAM obtenido del campo « access_token » de la salida de la API en el paso anterior. En la salida de tu API, puedes encontrar el ID de tu cuenta de IBM Cloud en el campo « resources.metadata.guid ».

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

Salida de ejemplo

{
    "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. Genere una nueva señal de IBM Cloud IAM que incluya sus credenciales de IBM Cloud y el ID de la cuenta con el que desea trabajar.

Si utiliza una clave de API de IBM Cloud, debe utilizar el ID de cuenta de IBM Cloud y la clave de API se ha creado para la misma. Para acceder a los espacios de trabajo o a las acciones de Schematics en la cuenta B, inicie sesión en la cuenta B y cree una clave de API de IBM Cloud basada en la cuenta 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
}

Puedes encontrar el token IAM « IBM Cloud » en el campo « access_token » y el token de actualización en el campo « refresh_token » de los resultados de la API.

4. Utilice la API de Schematics para obtener una lista de todos los espacios de trabajo de la cuenta.

Sintaxis para mostrar todos los espacios de trabajo

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

Sintaxis para obtener información sobre un espacio de trabajo concreto:

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

5. Revise la documentación de la API deIBM Cloud Schematics para obtener una lista de APIs soportados.

Actualización de los tokens de acceso IAM de IBM Cloud y obtención de nuevos tokens mediante la API

Un token de acceso a IBM Cloud® Identity and Access Management (IAM) caduca al cabo de una hora. Debe renovar la señal de acceso de forma periódica para garantizar el acceso a la API de IBM Cloud. Puedes seguir los mismos pasos para obtener un nuevo token.

Antes de empezar, asegúrate de que dispones de un token de actualización de IAM válido de IBM Cloud o de una clave API de IBM Cloud que puedas utilizar para solicitar un nuevo token de acceso.

• Renovar señal: Siga las instrucciones de Automatización del proceso de creación y gestión del espacio de trabajo con la API de IBM Cloud.
• Clave API: Obtén tu IBM Cloud clave API de la siguiente manera.
  1. En la barra de menús, pulse Gestionar > Acceso (IAM).
  2. Pulse la página Usuarios y, a continuación, selecciónese usted mismo.
  3. En el panel Claves de API, pulse Crear una clave de API de IBM Cloud.
  4. Especifique un Nombre y una Descripción para la clave de API y, a continuación, pulse Crear.
  5. Pulse Mostrar para ver la clave de API generada en su nombre.
  6. Copie la clave de API de forma que la pueda utilizar para recuperar su señal de acceso de IBM Cloud IAM.

Utilice los pasos siguientes si desea crear una señal de IBM Cloud IAM o si desea obtener una nueva señal de renovación.

1. Genere una nueva señal de acceso de IBM Cloud IAM utilizando la señal de renovación o la clave de API de IBM Cloud.

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

Salida de API de ejemplo

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

Puedes encontrar tu nuevo token IAM de IBM Cloud en el campo « access_token », y el token de actualización en el campo « refresh_token » de los resultados de la API.

2. Sigue trabajando con la documentación de la API de IBM Cloud Schematics utilizando el token del paso anterior.