Las API REST de API Connect
Cómo empezar a utilizar las API REST de API Connect
ElAPI Connect Las API REST se pueden utilizar para las siguientes acciones:
- Automatizar la administración deAPI Connect .
- Implementar scripts y herramientas para dar soporte a un entorno de integración continuo para para el desarrollo y la publicación de APIs.
- Gestionar catálogos de APIs y los suscriptores correspondientes.
- Ver datos analíticos.
Documentación de referencia completa para elAPI Connect Las API REST están disponibles aquí:API Connect Documentación de la API REST .
Requisitos previos
Para utilizar las API Connect API REST, debe cumplir los siguientes requisitos previos:
- Tener unAPI Connect Usuario que es miembro de una organización proveedora o de consumidores.
- Credenciales de la aplicación: client_id y client_secret. Estas credenciales se pueden obtener de la Administrador de API UI, o proporcionada por suAPI Connect administrador.
Para obtener las URL del punto final de la API y las credenciales de la aplicación, siga estos pasos:
- En el Administrador de API página de inicio de la interfaz de usuario, haga clic en Descargar kit de herramientas teja.
- Descargar el Credenciales del kit de herramientas (No es necesario descargar CLI o API Designer).
- Abre el descargado
credentials.jsonarchivo para ver la plataforma y los puntos finales del consumidor, y las credenciales para llamar a las API en estos puntos finales:{ "cloud_id": "e8fcdec3-bfb9-44bd-bf90-03d8639c4916", "toolkit": { "endpoint": "https://example-platform-api.ibm.com/api", "client_id": "7ad7b6c5-fa07-4222-808d-8de7266dcd1a", "client_secret": "b7127e44-4811-48be-be9d-6591302de04a" }, "consumer_toolkit": { "endpoint": "https://example-consumser-api.ibm.com/consumer-api", "client_id": "3b10e0db-1cd4-4aa8-af02-51a83e334f1c", "client_secret": "a5a672b7-e3b2-4d2b-984b-4059ea82ae65" }, "governance": { "endpoint": "https://example-governance.ibm.com/governance", "client_id": "ba48537c-7a6e-4232-92b6-ae67ad764933", "client_secret": "790d8a6d-e323-46bd-a05c-3d212e93d794" }, "discovery": { "endpoint": "https://example-discovery.ibm.com/discovery", "client_id": "d872a2f4-bc6e-4e91-b187-bbb5b99d4605", "client_secret": "c0b5ddf9-58e6-4246-88de-243ce217731a" } }Los puntos finales y las credenciales que están contenidos en elcredentials.jsonel archivo estoolkit: el punto final de la API de la plataforma. Utilícelo para llamadas API con ámbito de organización del proveedor.consumer_toolkit: el punto final de la API del consumidor. Utilícelo para llamadas API con ámbito de organización de consumidores, como la creación de una aplicación en una organización de consumidores.governance: Ver el Gobernanza de API característica.discovery: Ver el Descubrimiento de API característica.
credentials.json archivo.Obtención de una señal de portadora
Cada llamada a las API REST debe autenticarse con un token de portador en la cabecera HTTP Authorization . Cree una clave de API. Para obtener más información sobre cómo crear una clave API, consulte Gestión de claves API REST de plataforma.
curl -v -k -X POST -d '{"api_key": "<api_key>", "client_id": "<client_id>", "client_secret": "<client_secret>", "grant_type": "api_key"}' -H 'Content-Type: application/json' -H 'Accept: application/json' https://<management_server_platform_api_endpoint>/api/token<api-key>es la clave API que ha generado.<client_id>es el ID de cliente de la sección "toolkit" del archivocredentials.json, o el que le proporcione su administrador de la nube API Connect.<client_secret>es el secreto del cliente de la sección "toolkit" del archivocredentials.json, o el que le proporcione su administrador de la nube API Connect.provider/default-idp-2para miembros de organizaciones proveedoras.- consumer:
<provider org>:<catalog>/<catalog>-idppara miembros de organizaciones de consumidores.
El token al portador se devuelve en elaccess_token propiedad:
{
"access_token": "<bearer_token>",
"token_type": "Bearer",
"expires_in": 28800
}
expires_in El valor es el número de segundos antes de que caduque el token. Después del vencimiento, debe solicitar un nuevo token al portador.Realizar llamadas a la API REST
curl -k -X <HTTP Method> --url 'https://<rest api endpoint>/<api path> -H 'Authorization: Bearer <bearer_token>'-H 'X-IBM-Consumer-Context: <provider org>.<catalog>'Ejemplos de llamadas a la API REST
- Obtenga una lista de las organizaciones proveedoras
- Utilice un token de portador que se creó con las credenciales de miembro de la organización proveedora y especifique el punto final de API de la plataforma:
curl -k -X GET --url 'https://<platform api endpoint>/api/orgs' -H 'Authorization: Bearer <bearer_token>' - Obtener una lista de las aplicaciones en un catálogo
- Utilice un token de portador creado con credenciales de miembro de la organización de consumidores, especifique el punto final de la API del consumidor e incluya el
X-IBM-Consumer-Contextencabezamiento:curl -k -X GET --url 'https://<consumer api endpoint>/consumer-api/orgs/<consumer org>/apps' -H 'X-IBM-Consumer-Context: <provider org>.<catalog>' -H 'Authorization: Bearer <bearer_token>' - Obtenga datos de eventos de API de análisis para un catálogo:
curl -k -X GET --url 'https://<platform api endpoint>/analytics/<analytics service>/orgs/<provider org>/events' -H 'Authorization: Bearer <bearer_token>'Para datos analíticos del ámbito de la organización del proveedor, utilice <punto final de API de plataforma>.
Para datos analíticos con alcance de organización de consumidores, utilice <punto final de la API del consumidor>, y/consumer-analyticsen lugar de/analytics. Incluya también elX-IBM-Consumer-Contextencabezamiento. Por ejemplo:curl -k -X GET --url 'https://<consumer api endpoint>/consumer-analytics/orgs/<consumer org>/dashboard' -H 'X-IBM-Consumer-Context: <provider org>.<catalog>' -H 'Authorization: Bearer <bearer_token>'Para obtener más información sobre cómo consultar datos analíticos con la API REST, consulte Uso de la API REST de análisis.
Documentación de referencia de las API REST de API Connect : API Connect Documentación de las API REST.
Solución de problemas de llamadas fallidas a la API REST
El código de retorno y el mensaje de error de la página HTTP proporcionan información sobre las posibles causas del fallo:
- HTTP 403:
Prohibido
. Verifique que su token de portador se haya creado con las credenciales correctas para la llamada API. - HTTP 404:
No encontrado
. Verifique que la ruta y la URL de su punto final de API sean correctas. ¿Está realizando una llamada a la API del consumidor en el punto final de la API de la plataforma? - HTTP 401:
No autorizado
. Verifique que su token al portador sea correcto y no esté vencido. Si esto se devuelve cuando solicita un token al portador, verifique que elusername,password,realm,client_id, yclient_secretson correctos.