Uso de la API REST de administración

Event Streams proporciona una API RESTful de administración que puede utilizar para crear, suprimir, listar y actualizar temas.

Debe recuperar los detalles de URL y de credenciales necesarios para conectarse a la API desde un objeto de credenciales de servicio o una clave de servicio para la instancia de servicio. Para obtener información sobre cómo crear estos objetos, consulte Conexión a Event Streams.

El URL del punto final de la API se proporciona en la propiedad kafka_admin_url.

Las credenciales dependen del método de autenticación y se da soporte a tres tipos de credenciales.

Autenticar utilizando autenticación básica

Utilice las propiedades user y api_key de los objetos como nombre de usuario y contraseña. Coloque estos valores en la cabecera Authorization de la solicitud HTTP con el formato Basic <base64 encoding of username and password joined by a single colon (:)>.

Autenticar utilizando una señal portadora

Para obtener la señal utilizando la CLI de IBM Cloud, primero inicie sesión en IBM Cloud y, a continuación, ejecute el mandato siguiente:

ibmcloud iam oauth-tokens

Coloque esta señal en la cabecera de autorización de la solicitud HTTP en forma de Bearer <token>. Se admiten tanto señales de clave de API como señales JWT.

Autenticar utilizando api_key

Coloque la clave directamente como el valor de la cabecera HTTP de X-Auth-Token.

Próximos pasos

Para obtener una descripción de la API con ejemplos, consulte Event Streams admin-rest.

Puede descargar la especificación completa para la API desde el archivo YAML de la API REST de administración de Event Streams. Para ver el archivo swagger, utilice las herramientas Swagger, por ejemplo, Editor Swagger.