Generación de claves de API para la autenticación

Con una clave de API, puede autenticarse automáticamente en IBM watsonx desde un script o aplicación. Las claves de API están asociadas con sus credenciales y son específicas de usted. Con las claves de API, puede autenticarse sin especificar la contraseña.

También puede generar una nueva clave API mediante programación utilizando el punto final Get API key . Sin embargo, este punto final requiere un token de autorización ZenApiKey o Bearer , y no se recomienda.

Su clave API de plataforma permite a los scripts y aplicaciones acceder a todo aquello a lo que normalmente podría acceder cuando inicia sesión en el cliente web IBM watsonx. Una clave de API de instancia sólo habilita el acceso a la instancia específica desde la que se genera.

Antes de generar una clave de API, tenga en cuenta los factores siguientes:
¿Qué nivel de acceso se requiere?
Como práctica recomendada de seguridad, se recomienda que otorgue la menor cantidad de acceso necesario al script o a la aplicación. Por ejemplo, si un script sólo necesita interactuar con una instancia de servicio específica, genere una clave de API para dicha instancia de servicio.
¿Qué tipo de clave puedo generar?
Algunos servicios no dan soporte a las claves de API a nivel de instancia. Si no puede generar una clave de API que sea específica del servicio, debe utilizar la clave de API de la plataforma.
Importante: Asegúrese de almacenar las claves de API en algún lugar seguro. Si pierde una clave de API, debe crear una nueva clave y actualizar los scripts o aplicaciones en los que se utiliza la clave.

Clave de API de plataforma

Con una clave API de plataforma, puede acceder a todo aquello a lo que normalmente podría acceder cuando inicia sesión en el cliente web IBM watsonx.

Para generar una clave de API de plataforma:

  1. Inicie sesión en el cliente web.
  2. En la barra de herramientas, pulse su avatar.
  3. Pulse Perfil y valores.
  4. Haga clic en Clave API > Generar nueva clave.
  5. Pulse Generar.
  6. Pulse Copiar y guarde la clave en algún lugar seguro. No puede recuperar esta clave si la pierde.

Si pierde la clave de API, repita los pasos anteriores para generar una nueva clave de API. La clave de API antigua deja de ser válida y las aplicaciones o scripts no se pueden autenticar en la plataforma hasta que proporcione la nueva clave de API.

Si cree que la clave de API está comprometida:

  1. Inicie sesión en el cliente web.
  2. En la barra de herramientas, pulse su avatar.
  3. Pulse Perfil y valores.
  4. Haga clic en Clave API > Revocar clave actual.
  5. Pulse Revocar.

Las aplicaciones o scripts que utilicen la clave no podrán autenticarse en la plataforma.

Claves de API de instancia

Si tiene acceso a una instancia específica de un servicio, puede generar una clave de API para acceder sólo a esa instancia de servicio.

Restricción: Es posible que esta característica no esté disponible para todos los servicios.

Para generar una clave de API de instancia:

  1. Inicie sesión en el cliente web.
  2. En el menú de navegación, seleccione Servicios > Instancias.
  3. Pulse el nombre de la instancia para la que desea generar una clave de API.
  4. Haga clic en Clave API de instancia > Generar clave API.
  5. Pulse Generar.
  6. Pulse Copiar y guarde la clave en algún lugar seguro. No puede recuperar esta clave si la pierde.

Si pierde la clave de API, repita los pasos anteriores para generar una nueva clave de API. La clave de API antigua deja de ser válida y las aplicaciones o scripts no se pueden autenticar en la instancia hasta que proporcione la nueva clave de API.

Si cree que la clave de API está comprometida:

  1. Inicie sesión en el cliente web.
  2. En el menú de navegación, seleccione Servicios > Instancias.
  3. Pulse el nombre de la instancia para la que desea revocar la clave de API actual.
  4. Haga clic en Clave API de instancia > Revocar clave API.
  5. Pulse Revocar.

Las aplicaciones o scripts que utilicen la clave no podrán autenticarse en la instancia.

Señales de API

Para generar un token de autorización de API, utilice uno de los siguientes métodos.