Gerenciando suas chaves com a API de serviço de gerenciamento de chaves
IBM Cloud® Hyper Protect Crypto Services fornece uma API de serviço de gerenciamento de chave para armazenar, recuperar e gerar chaves de criptografia.
Recuperando as suas credenciais do IBM Cloud
Para trabalhar com a API, é necessário gerar suas credenciais de serviço e autenticação. Para reunir suas credenciais:
Formando sua solicitação de API de serviço de gerenciamento de chaves
Ao fazer uma chamada API para o serviço, estruture sua solicitação de API de acordo com a maneira como você inicialmente provisionou sua instância do Hyper Protect Crypto Services.
Para construir sua solicitação, emparelhe um terminal em serviço
regional com as credenciais de autenticação apropriadas. Por exemplo, se você criou uma instância de serviço para a região us-south, use o terminal a seguir e os cabeçalhos de API para procurar chaves em seu serviço:
Se você criar suas instâncias após 12 de abril de 2024 em determinadas regiões, poderá ser necessário usar os novos terminais de API com o novo formato como <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud A data
de disponibilidade varia por região. Para obter mais informações sobre as regiões suportadas, as datas de disponibilidade e as novas URLs de terminal, consulte Novos terminais
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>'
-
Substitua
<port>pelo número da porta do seu terminal de API. É possível obter o<port>em seu painel de instância de serviço provisionado por meio de Visão Geral > URL do terminal de gerenciamento de chave Ou, é possível recuperar dinamicamente a URL de terminal da API.Note que a faixa de porta de uma instância Hyper Protect Crypto Services está entre
8000-19999.O valor retornado inclui:
{ "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 o serviço de gerenciamento de chaves, use o
<region>e o<instance_ID>na seçãokms. -
Substitua
<access_token>e<instance_ID>por seu serviço recuperado e as credenciais de autenticação.
Deseja rastrear suas solicitações de API no caso de algo sair errado? Quando você inclui o sinalizador -v como parte da solicitação cURL, você obtém um valor correlation-id nos cabeçalhos de resposta. É possível usar
esse valor para correlacionar e rastrear a solicitação para fins de depuração.
O que vem a seguir
Você está pronto para iniciar o gerenciamento de suas chaves de criptografia e dados. Para saber mais sobre o gerenciamento programático de suas chaves, efetue check-out do documento de referência da API do serviço de gerenciamento de chave