API einrichten

IBM® Key Protect for IBM Cloud® stellt eine REST-API bereit, die mit jeder Programmiersprache verwendet werden kann, um Verschlüsselungsschlüssel zu speichern, abzurufen und zu generieren.

IBM Cloud-Berechtigungsnachweise abrufen

Zur Arbeit mit der API müssen Sie eigene Service- und Authentifizierungsnachweise generieren.

Gehen Sie wie folgt vor, um Ihre Berechtigungsnachweise zusammenzustellen:

  1. Generieren Sie ein IBM Cloud IAM-Zugriffstoken.

  2. Rufen Sie die Instanz-ID ab, die Ihre Key Protect-Instanz eindeutig identifiziert.

API-Anforderung formulieren

Wenn Sie einen API-Aufruf an den Service durchfuhren, strukturieren Sie Ihre API-Anforderung so, wie Sie ursprünglich Ihre Instanz bereitgestellt haben von Key Protect.

Um Ihre Anforderung zu erstellen, kombinieren Sie einen Serviceendpunkt mit dem entsprechenden Authentifizierungsnachweis. Wenn Sie beispielsweise eine Key Protect-Instanz für die us-south-Region erstellt haben, verwenden Sie die folgenden Endpunkt- und API-Header, um Schlüssel in Ihrem Service zu durchsuchen:

$ 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>"

Ersetzen Sie <access_token> und <instance_ID> durch Ihre abgerufenen Service- und Authentifizierungsberechtigungsnachweise.

Möchten Sie Ihre API-Anfragen verfolgen können, wenn etwas schiefgeht? Wenn Sie das Flag -v als Teil der Anforderung curl einschließen, erhalten Sie einen Wert für correlation-id in den Antwortheadern. Sie können diesen Wert verwenden, um die Anforderung zu Debugzwecken zu korrelieren und zu verfolgen.

Nächste Schritte

Sie sind bereit, mit der Verwaltung Ihrer Verschlüsselungsschlüssel zu beginnen in Key Protect. Weitere Informationen zur programmgesteuerten Verwaltung Ihrer Schlüssel entnehmen Sie dem Referenzdokument zur Key Protect-API.