Autenticação

As APIs da DigiCert CertCentral usam chaves de API para a autenticação e autorização. Fazer a autenticação ao serviço deve ser relativamente simples se você nunca trabalhou com autenticação baseada em cabeçalho antes.

Autenticação baseada em cabeçalho

Cada solicitação ao serviço deve incluir uma chave de API. Isso é feito usando o cabeçalho padrão HTTP X‑DC‑DEVKEY. Aqui está uma solicitação simples de API ao ponto de extremidade Listar usuários da API de serviços usando cURL.

Certifique-se de substituir {{api_key}} pela sua chave de API real.

bash
curl -X GET \
  'https://www.digicert.com/services/v2/user' \
  -H 'Content-Type: application/xml' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Gerar uma chave API

Após a geração de uma chave, nós a exibimos apenas uma vez. Não há formas de recuperar uma chave de API perdida. Se perder uma chave, será necessário revogar a chave perdida e gerar uma nova.

Chaves de API são geradas e gerenciadas na sua conta da CertCentral. Para gerar uma nova chave, entre na sua conta da CertCentral.

  1. Na sua conta da CertCentral, no menu da barra lateral, clique em Conta > Acesso à conta.

  2. Na página Acesso à conta, em Chaves de API, clique em Adicionar chave de API.

  3. Na janela de Adicionar chave de API, insira uma Descrição para a chave nova.

    Por exemplo, insira o nome do app ou usuário a quem você está vinculando chave.

  4. No menu suspenso de Usuário, selecione a quem você deseja vincular a chave.

Tenha em mente que ao vincular uma chave a um usuário, você vinculará as permissões de tal usuário à chave. Isso significa que a chave estará autorizada a realizar quaisquer ações que o usuário pode.

  1. (Esta etapa é opcional) Para restringir as permissões das chaves de API para um conjunto especificado de ações, no menu suspenso Restrições da chave de API (opcional), selecione uma destas opções:

  2. Clique em Adicionar chave de API.

  3. Na janela Nova chave de API, clique na chave gerada para copiá-la.

  4. Salve a chave em um local seguro. (Lembre-se, a chave só é exibida esta vez.)

  5. Após salvar a chave, clique em Eu entendo que não verei isso novamente.

E depois?

Agora você está começando a usar as APIs da DigiCert CertCentral. Sua nova chave de API é adicionada à lista na página Acesso à conta. Volte a esta página para rastrear chaves de API (ativas ou revogadas) ou revogar chaves de API.

Editar uma chave API

Conforme necessário, é possível editar uma chave de API para atualizar a descrição ou para modificar as permissões das chaves.

  1. Na sua conta da CertCentral, no menu da barra lateral, clique em Conta > Acesso à conta.

  2. Na página Acesso à conta, em Chaves de API, clique no link Nome da chave de API.

  3. Na janela Atualizar chave de API, modifique a Descrição ou atualize as permissões da chave de API.

  4. Para remover restrições de chaves de API, no campo Restrições de chave de API (opcional), que no X no fim da entrada. O campo agora será Nenhum.

  5. Para atualizar as permissões das chaves de API, no menu suspenso Restrições da chave de API (opcional), selecione uma destas opções:

Tenha em mente que ao adicionar restrições de permissão à uma chave de API ativa, você interromperá quaisquer integrações usando tal chave se permissões expandidas forem necessárias. Para corrigir essas integrações interrompidas, será necessário editar a chave e remover as restrições.

  1. Clique em Adicionar chave de API para atualizar.

Informações relacionadas