Gestión de claves con la API de servicio de gestión de claves

IBM Cloud®Hyper Protect Crypto Services provee un API de servicio de gestión de claves para almacenar, recuperar y generar claves de cifrado.

Recuperación de sus credenciales de IBM Cloud

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

Genere una señal de acceso de IBM Cloud IAM.
Recupere el ID de instancia que identifica de forma exclusiva la instancia de servicio de Hyper Protect Crypto Services.

Formar la solicitud de API de servicio de gestión de claves

Cuando se realiza una llamada de API al servicio, la solicitud de API se estructura de acuerdo a cómo se suministró su instancia de Hyper Protect Crypto Services.

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

Si crea sus instancias después del 12 de abril de 2024 en ciertas regiones, es posible que deba usar los nuevos puntos finales de API con el nuevo formato como <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud. La fecha de disponibilidad varía según la región. Para obtener más información sobre las regiones admitidas, las fechas de disponibilidad y las nuevas URL de punto final, consulte Nuevos puntos finales.

curl -X GET \
    https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud/api/v2/keys \
    -H 'accept: application/vnd.ibm.collection+json' \
    -H 'authorization: Bearer <access_token>' \
    -H 'bluemix-instance: <instance_ID>'

Sustituya <port> por el número de puerto del punto final de la API. Puedes conseguir el <port> en el panel de su instancia de servicio aprovisionada a través de Descripción general >URL del punto final de administración de claves. O puedes dinámicamente recuperar la URL del punto final de la API.

Tenga en cuenta que el rango de puertos de una instancia de Hyper Protect Crypto Services está entre 8000- 19999.

El valor devuelto incluye:
```
{
  "instance_id": "<instance_ID>",
  "kms": {
    "public": "<instance_ID>.api.<region>.hs-crypto.appdomain.cloud",
    "private":"<instance_ID>.api.private.<region>.hs-crypto.appdomain.cloud"
  },
    "ep11": {
    "public": "<instance_ID>.ep11.<region>.hs-crypto.appdomain.cloud",
    "private":"<instance_ID>.ep11.private.<region>.hs-crypto.appdomain.cloud"
  }
}
```
Para el servicio de gestión de claves, utilice <region> y <instance_ID> en la sección kms.
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 se incluye el distintivo -v como parte de la solicitud cURL, se obtiene un valor de 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á todo listo para empezar a gestionar datos y claves de cifrado. Para obtener más información sobre cómo administrar sus claves mediante programación,consulte el documento de referencia de la API del servicio de administración de claves.