Configurar MID Web Server autenticação de chave de API

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura

    • Autentique as solicitações de entrada de clientes para a extensão MID Web Server usando a autenticação de chave de API. A autenticação de API é uma maneira segura e simples de autenticar sua solicitação. Você pode criar ou modificar uma chave de API MID Web Server.

    Antes de Iniciar

    Crie uma extensão MID Web Server para usar a autenticação de chave de API, conforme descrito em Configurar a extensão MID Web Server. Certifique-se de selecionar a Chave de API no campo Tipo de autenticação da extensão.

    Função necessária: event_mgmt_admin

    Por Que e Quando Desempenhar Esta Tarefa

    Por padrão, o número máximo de chaves de API que você pode criar em uma instância é 10. Para alterar este número, modifique o valor da propriedade mid.webserver.max.api.keys na página Propriedades do sistema.

    Ao trabalhar no domínio global enquanto a Separação de domínios estiver habilitada, as chaves de API estarão disponíveis para todas as extensões, independentemente do domínio. Ao trabalhar em um domínio específico, as chaves de API estão disponíveis para extensões nesse domínio, seus domínios primários, e o domínio global.

    Você pode configurar chaves de API para expirar em uma data especificada.

    Ao criar uma nova extensão com autenticação de chave de API (ou atualizar uma existente para usar a autenticação de chave de API), o sistema verifica se há uma chave de API disponível para a extensão. Se não houver chave de API disponível, o sistema criará uma.

    Procedimento

    1. Navegar até Tudo > MID Server > Perfis e implantações > Chave de API de servidor Web MID.
    2. Crie uma nova chave de API ou modifique uma chave de API existente.
      • Para criar uma nova chave de API:
        1. Selecione Novo.
        2. No formulário Chave de API do MID Web Server, preencha os campos.
          Tabela 1. MID Web Server Formulário de chave de API
          Campo Descrição
          Nome Nome da chave de API.
          Ativo Opção para ativar a chave de API.
          Chave de autenticação Valor codificado somente leitura da chave de autenticação. Nenhum valor aparece até que você configure a chave.
          Expira Opção para definir uma data de expiração para a chave de API.

          Chaves de API expiradas, desativadas ou excluídas não são aceitas pela extensão do servidor web.
        3. Selecione Enviar para salvar a chave de API.

          A chave de API aparece na página Chaves de API do MID Web Server.

      • Para modificar uma chave de API existente:
        1. Navegar até MID Server > Perfis e implantações > Chave de API de servidor Web MID.
        2. Selecione uma chave de API na página.
        3. Na seção Links relacionados, selecione Exibir chave de API.
        4. Copie a chave de API que aparece na caixa de diálogo do MID Web Server.

          Ao se conectar a uma extensão MID Web Server configurada com autenticação de chave de API, coloque uma chave de API à qual a extensão tenha acesso no cabeçalho de autorização da solicitação no seguinte formato:

          Chave<API_KEY>

          onde<API_KEY> é o valor da chave de API exibida após a seleção de Exibir chave de API .
        5. Selecione Enviar.