Configuración del entorno de API

Antes de poder utilizar la API Direct Link, debe configurar su entorno.

Requisitos previos generales

Configura tu cuenta para acceder al enlace directo. Asegúrese de que su cuenta se haya actualizado a una cuenta de pago.

Requisitos previos de la API

Antes de poder utilizar la API para interactuar con un enlace directo, debe obtener un token de IAM y almacenar el punto final como una variable. Compruebe también que tiene acceso al servicio API IBM Cloud Direct Link.

Los ejemplos siguientes utilizan el punto final global de directlink.cloud.ibm.com.

Paso 1: Almacenar la clave de API como una variable

Ejecute el mandato siguiente para almacenar la clave de API correspondiente a la cuenta en una variable de entorno. Si no tiene ninguna clave de API, consulte Creación de una clave de API.

apikey="<YOUR_API_KEY>"

Paso 2: Obtener una señal de IBM Identity and Access Management (IAM)

Ejecuta el siguiente comando para obtener y analizar un token de IAM utilizando la utilidad de procesamiento de JSON jq. Puede modificar el mandato para utilizar otra herramienta de análisis, o bien puede eliminar la última parte del mandato si prefiere analizar la señal de forma manual.

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 ver el token IAM, ejecute echo $IAM_TOKEN. El resultado tiene este aspecto:

Bearer <your_token>

La cabecera de autorización espera que la señal empiece por Bearer. Si el resultado no incluye Bearer, actualice la variable iam_token para incluirla. En estos ejemplos se presupone que Bearer está incluido en IAM_TOKEN.

Puesto que la señal de IAM caduca, debe repetir el paso anterior para renovar la señal cada hora.

Paso 3: Almacenar el punto final de la API como una variable

Ejecute el mandato siguiente para almacenar el punto final de la API en una variable para que pueda reutilizarse más adelante en la sesión.

Punto final público:

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

Punto final privado virtual:

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

Para comprobar que la variable se ha guardado, ejecuta y echo $directlink_api_endpoint asegúrate de que la respuesta no esté vacía.

Paso 4: Almacenar la versión de la API como una variable

Cada solicitud de API debe incluir el parámetro version en el formato YYYY-MM-DD. Ejecute el siguiente mandato para almacenar la fecha de la versión en una variable para poderla reutilizar en la sesión. Para obtener más información sobre cómo configurar el parámetro version, consulta Control de versiones en la API de Direct Link.

api_version="2020-03-31"

Para verificar que esta variable se ha guardado, ejecute echo $api_version y asegúrese de que la respuesta no esté vacía.

Paso 5: Verificar que tiene acceso a la API

Si recibe resultados inesperados, añada el distintivo --verbose (depuración) después del mandato curl para obtener información de registro detallada.

Llame a la API Listar ubicaciones disponibles para ver las ubicaciones disponibles para el enlace directo, en formato JSON. Al menos un objeto regresa.

Este ejemplo enumera las ubicaciones disponibles para una pasarela Direct Link Dedicated. Para Direct Link Connect, sustituya connect por dedicated.
```
curl -X GET "$directlink_api_endpoint/v1/offering_types/dedicated/locations?version=$api_version"   -H "Authorization: $IAM_TOKEN"
```

Llama a la API de List gateways para ver los enlaces directos que ya hayas creado en tu cuenta, en formato JSON.

curl -X GET "$directlink_api_endpoint/v1/gateways?version=$api_version"   -H "Authorization: $IAM_TOKEN"