Configuración de la API

IBM® Key Protect for IBM Cloud® proporciona una API REST que puede utilizarse con cualquier lenguaje de programación para almacenar, recuperar y generar claves de cifrado.

Recuperación de las credenciales de IBM Cloud

Para trabajar con la API, debe generar credenciales de servicio y autenticación.

Para recopilar sus credenciales:

  1. Genere una señal de acceso de IBM Cloud IAM.

  2. Recupere el ID de instancia que identifica de forma exclusiva su instancia de Key Protect.

Cómo crear una solicitud de API

Cuando realice una llamada de API al servicio, estructure la solicitud de API según como haya suministrado inicialmente su instancia de Key Protect.

Para crear su solicitud, tiene que emparejar un punto final de servicio con las credenciales de autenticación adecuadas. Por ejemplo, si ha creado una instancia de Key Protect para la región us-south, utilice el siguiente punto final y las siguientes cabeceras de API para examinar las claves del servicio:

$ curl -X GET \
    "https://us-south.kms.cloud.ibm.com/api/v2/keys" \
    -H "accept: application/vnd.ibm.collection+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

Sustituya <access_token> y <instance_ID> por el servicio recuperado y las credenciales de autenticación.

¿Desea realizar un seguimiento de las solicitudes de API por si algo va mal? Cuando incluya el distintivo -v como parte de la solicitud curl, obtendrá un valor correlation-id en las cabeceras de respuesta. Puede utilizar este valor para correlacionar y realizar un seguimiento de la solicitud con fines de depuración.

Qué hacer a continuación

Ya está listo para empezar a gestionar las claves de cifrado en Key Protect. Para obtener más información sobre cómo gestionar las claves mediante programación, consulte el documento de referencia de la API de Key Protect.