Como criar a política de acesso de REST API

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • Crie uma política de acesso de API e mapeie um perfil de autenticação para restringir o tipo de autenticação de uma REST API. Por exemplo, você pode criar uma política de acesso de API que permita somente a autenticação de token de ID para uma REST API.

    Antes de Iniciar

    Certifique-se de criar um perfil de autenticação. Para obter mais informações, consulte Como criar um perfil de autenticação.

    Função necessária: administrador

    Procedimento

    1. Navegar até Tudo > Serviços web do sistema > Políticas de acesso de REST API.
    2. Selecione Novo.
    3. Preencha os campos no formulário.
      Campos da política de acesso de API
      Tabela 1. Políticas de acesso de API
      Campo Descrição
      Nome Nome exclusivo da política de acesso de API.
      Ativo Opção para ativar a política de acesso de API.
      REST API A REST API à qual a política de acesso é aplicada. Por exemplo, API de anexos.
      REST API PATH Caminho da API da REST API. Esse campo é preenchido automaticamente com base na REST API selecionada. Por exemplo, now/attachment.
      Método HTTP Método usado para interagir com a API. Esse campo é preenchido automaticamente com base na REST API selecionada.
      Versão Versão da API. Por exemplo, v1. Esse campo é preenchido automaticamente com base na REST API selecionada.
      Nota:
      Se você quiser criar uma política de autenticação para todas as versões de uma REST API, deverá criar políticas individuais para cada versão.
      Recurso Recurso secundário da REST API. Esse campo é preenchido automaticamente com base na REST API selecionada. Por exemplo, /now/attachment
      Tabela A tabela à qual a política de acesso de API é aplicada. Essa opção se aplica somente a políticas para a API de Tabela.
      Aplicação Escopo da aplicação.
      Global Opção para aplicar a política a todos os métodos, versões e recursos para a API.
      Aplicar a todos os métodos Opção para aplicar a política a todos os métodos, versões e recursos para a API.
      Aplicar a todos os recursos Opção para aplicar a política a todos os recursos ou aos da API.
      Aplicar a todas as versões Opção para aplicar a política a todas as versões ou às da API.
      Aplicar a todas as tabelas Opção para aplicar a política a todas as tabelas. Essa opção se aplica somente a políticas para a API de Tabela.
      Nota:
      Para entender mais sobre a priorização da política de acesso de API, consulte Priorização da política de acesso de API.
    4. Clique duas vezes em Inserir nova linha.
    5. Selecione um perfil de autenticação de entrada na lista e clique no ícone de salvamento ícone de salvamento.
      Por exemplo, você pode adicionar a autenticação básica, o token de ID, a autenticação baseada em certificado, o OAuth ou a autenticação WSSE.
      1. Para adicionar um ou mais perfis de autenticação de entrada, clique em Novo e crie um perfil.
      2. Selecione Quais tipos de perfis de autenticação?.
        • Criar perfis de autenticação HTTP padrão
        • Criar perfis de autenticação de WSSE
        perfil de autenticação
      3. Depois de criar o perfil de autenticação, salve o registro.
    6. Clique em Enviar para enviar a política de acesso da REST API.