Gestion de vos clés avec l'interface de programmation de service de gestion de clés

IBM Cloud®Hyper Protect Crypto Services fournit un API du service de gestion de clés pour stocker, récupérer et générer des clés de chiffrement.

Extraction de vos données d'identification IBM Cloud

Pour utiliser l'API, vous devez générer vos données d'authentification et d'identification de service. Pour rassembler vos données d'identification :

  1. Générez un jeton d'accès IBM Cloud IAM.
  2. Extrayez l'ID d'instance qui identifie votre instance de service Hyper Protect Crypto Services de manière univoque.

Formation de votre demande d'interface de programmation de service de gestion de clés

Lorsque vous soumettez un appel d'API au service, structurez votre demande d'API en fonction de la manière dont votre instance Hyper Protect Crypto Services a été initialement mise à disposition.

Pour générer une demande, associez un noeud final de service régional aux données d'authentification appropriées. Par exemple, si vous avez créé une instance de service pour la région us-south, utilisez le noeud final et les en-têtes API ci-dessous pour parcourir les clés du service :

Si vous créez vos instances après le 12 avril 2024 dans certaines régions, vous devrez peut-être utiliser les nouveaux points de terminaison d'API avec le nouveau format comme <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud. La date de disponibilité varie selon la région. Pour plus d'informations sur les régions prises en charge, les dates de disponibilité et les nouvelles URL de point de terminaison, consultez Nouveaux points de terminaison.

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>'
  • Remplacez <port> par le numéro de port de votre noeud final d'interface de programmation. Vous pouvez obtenir le <port> dans le tableau de bord de votre instance de service provisionné via Aperçu >URL du point de terminaison de gestion des clés. Ou bien, vous pouvez dynamiquement récupérer l'URL du point de terminaison de l'API.

    Notez que la plage de ports d'une instance Hyper Protect Crypto Services est comprise entre 8000 et 19999.

    La valeur retournée inclut :

    {
      "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"
      }
    }
    

    Pour le service de gestion des clés, utilisez <region> et <instance_ID> dans la section kms.

  • Remplacez <access_token> et <instance_ID> par le service récupéré et les données d'authentification.

Vous souhaitez effectuer le suivi de vos demandes d'API en cas de problème ? Lorsque vous incluez le drapeau -v dans le cadre d'une demande cURL, vous obtenez une valeur correlation-id dans les en-têtes de réponse. Vous pouvez utiliser cette valeur pour établir une corrélation et suivre la demande à des fins de débogage.

Etapes suivantes

Vous êtes maintenant prêt à commencer à gérer vos clés de chiffrement et vos données. Pour en savoir plus sur la gestion programmatique de vos clés,consultez le document de référence de l'API du service de gestion des clés.