Criando chaves de API e segredos

Editar online

Sobre essa tarefa

Chaves de API e segredos são as credenciais necessárias para usar um Gancho de API. Para que uma solicitação para um Gancho da API seja autorizada, ambos os cabeçalhos X-API-Key e X-API-Secret devem ser fornecidos Os valores da Chave API e do Segredo representam os valores desses cabeçalhos respectivamente.

Ao contrário dos Ganchos de API que têm escopo definido para um único Suíte de Teste, as Chaves de API e os Segredos têm escopo definido para uma Organização de Teste. Portanto, qualquer par de Chave de API e Segredo que for gerado dentro de uma Organização de teste terá permissão para autorizar solicitações para todos os Ganchos de API dentro da mesma organização, independentemente do Suíte de teste ao qual o Gancho de API está associado...

Procedimento

  1. Faça login no API Manager.
  2. Clique no bloco “Testar APIs”.
  3. Selecione um conjunto de testes.
  4. Vá para a guia Configurações > Ganchos e chaves de API.
  5. Para usar seu novo API Hook, você precisa ter uma chave API e um segredo.Chaves
    1. Vá até a seção “Chaves” e clique em “Adicionar ”.
    2. Digite o nome da chave.
    3. Clique em Salvar. O sistema exibirá a chave e o segredo. Guarde isso para referência futura. Se sua chave e seu segredo já estiverem configurados, consulte “Usando ganchos de API” para obter mais informações sobre como usar o gancho de API.

O quê fazer em seguida

Sua nova chave API agora está ativa e agora aparecerá na lista de chaves API no menu de navegação. Clicar na chave mostrará o valor da chave de API se você precisar referenciar isso novamente no futuro. Se você desejar remover a chave de API em qualquer momento, simplesmente clique no ícone Excluir ao lado da chave de API que você deseja remover Isso invalidará todas as solicitações futuras feitas aos API Hooks usando essa combinação de chave e segredo.