Gestión de recursos con la App Connect API

Puede utilizar la App Connect API para gestionar sus recursos después de obtener un token de acceso para la autenticación.

Acerca de esta tarea

Puede utilizar la App Connect API para proporcionar acceso a los recursos de su instancia, de modo que pueda administrar los archivos BAR, las configuraciones, los tiempos de ejecución de integración y la traza. Para más información, consulte la descripción general de la API.

Para utilizar la App Connect API, primero debe autenticar sus credenciales incluyendo un token de acceso en sus llamadas a la API. Para obtener un token de acceso, debe generar una clave de API, un ID de cliente y un secreto en App Connect. El ID de cliente representa una instancia específica de App Connect y todos los usuarios de esa instancia comparten el ID. La clave API representa a un usuario concreto de una instancia y es específica de ese usuario.

Si tiene un servicio que necesita acceder a la API, también puede crear un ID de servicio y, a continuación, crear una clave de API para el ID de servicio. El ID de servicio es un tipo de ID de usuario que representa ese servicio. Todos los usuarios de la instancia en la que se ha creado el ID de servicio pueden acceder al ID de servicio.

Acceder a la API con una clave API personal

Procedimiento

Los siguientes pasos describen cómo un usuario específico puede obtener un token de acceso generando una clave API, un ID de cliente y un secreto.

Acceda a su instancia de App Connect.
Genere una clave API completando los siguientes pasos.
1. Haga clic en sus iniciales en la cabecera App Connect y, a continuación, seleccione ID de servicio y claves API.
2. Haga clic en la pestaña Claves API y, a continuación, en Generar clave.
3. Introduzca un nombre para su clave API, añada una descripción si lo desea y, a continuación, haga clic en Generar clave.
  El nombre de la clave API puede tener hasta 32 caracteres y puede contener caracteres alfanuméricos, guiones bajos (_), guiones (-) y puntos (.).
  Se genera una clave API que es visible durante 300 segundos. Puede ver la clave haciendo clic en (Mostrar clave API ). No puede recuperar la clave API después de salir de esta pantalla. Por lo tanto, descárguela como archivo JSON haciendo clic en el enlace proporcionado, o haga clic en Copiar al portapapeles y, a continuación, pegue la clave en un archivo para su uso posterior. Después de descargar o copiar la clave, cierre el cuadro de diálogo.
Genere un ID de cliente y un secreto completando los siguientes pasos.
1. Expanda la categoría Conectar en el panel de navegación y, a continuación, haga clic en Credenciales de API pública.
2. En la página de credenciales de la API pública, haga clic en Generar.
3. Introduzca un nombre para su ID de cliente y haga clic en Generar.
  El nombre del ID de cliente puede tener hasta 40 caracteres y puede contener caracteres alfanuméricos, guiones bajos (_) y guiones (-).
  Se generan un identificador de cliente y un secreto. No puedes recuperar el secreto de cliente después de salir de esta pantalla. Copie los valores haciendo clic en Copiar en el portapapeles y, a continuación, péguelos en un archivo para utilizarlos más tarde. Después de copiar los valores, haga clic en Cerrar.
4. Opcional: Para descargar la especificación OpenAPI para esta API, haga clic en Especificación API.
Para obtener un token de acceso, utilice una herramienta como cURL para enviar una solicitud POST a la API App Connect para el objeto token (api/v1/tokens).
Debe facilitar la siguiente información.
- La dirección URL de la API de su App Connect instancia, que es https://api.region.appconnect.ipaas.automation.ibm.com, donde región es la región donde se aloja su instancia. Puede encontrar la región (como a-vir-c1) en URL para su instancia.
  También puede generar este URL en la especificación API seleccionando el servidor y la región. El servidor para la App Connect capacidad de IBM® webMethods Hybrid Integration es https://api.region.appconnect.ipaas.automation.ibm.com.
- El ID de instancia de su App Connect que es el identificador de nueve caracteres que aparece al principio de URL para su instancia.
- La clave API, el ID de cliente y el secreto de cliente que generó.
El siguiente ejemplo muestra la estructura del comando cURL que utilizarías con tus credenciales para obtener un token de acceso.
```
curl --request POST \
  --url https://api.region.appconnect.ipaas.automation.ibm.com/api/v1/tokens \
  --header 'X-IBM-Client-Id: clientId' \
  --header 'X-IBM-Client-Secret: clientSecret' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-ibm-instance-id: appConnectInstanceId' \
  --data '{
  "apiKey": "myapikey"
}'
```

Resultados

Si su solicitud tiene éxito y se confirman sus credenciales, se devuelve un token de acceso con el siguiente formato.

{
    "access_token": "myAccessToken",
    "token_type": "bearer",
    "scope": "appcon:manage",
    "expires_in": 43200
}

Nota: El token de acceso es válido durante 12 horas a partir de su creación. Transcurrido ese plazo, deberá solicitar una nueva ficha.

Cuando realice llamadas posteriores a la API, debe utilizar el encabezado X-IBM-Client-Id para proporcionar su ID de cliente y el encabezado

Authorization:
Bearer

para proporcionar este token de acceso. Por ejemplo, la siguiente llamada solicita una lista de configuraciones.

curl --request GET \
--url https://api.region.appconnect.ipaas.automation.ibm.com/api/v1/configurations \
--header "Authorization: Bearer myAccessToken" \
--header 'X-IBM-Client-Id: myClientId' \
--header 'accept: application/json'

Nota: Authorization: Bearer distingue entre mayúsculas y minúsculas y debe mencionarse en las llamadas con las mayúsculas correctas.

Acceso a la API con un ID de servicio compartido