---
sourceDocument: Segurança da plataforma Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-security

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Segurança da plataforma Yokohama

ft:clusterId :

    - psec

bundleId :

    - psec

workflow :

    - Platform


---

# Configurar chave de API - Autenticação baseada em token

# Configurar chave de API - Autenticação baseada em token {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

Configure uma chave de API para oferecer suporte à autenticação de endpoints de REST API.

## Antes de Iniciar

Função necessária: administrador

Plug-in necessário: chave de API e autenticação HMAC (<kbd class="ph userinput">com.glide.tokenbased_auth</kbd>)

## Procedimento

1. Crie um perfil de autenticação de entrada.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de APIPerfis de autenticação de entrada.
   2. Selecione Novo.  
      O sistema exibe a mensagem Que tipo de perfil de autenticação?
   3. Selecione Criar perfis de autenticação da chave de API.  
   4. No formulário, preencha os campos.  
      {#configure-api-key__table_pdg_vvm_nzb__entry__2}

      | Campo | Descrição |
      |-|-|
      | Nome | Nome para identificar a política de autenticação. |
      | Aplicação | Escopo da política de autenticação. |
      | Parâmetro de autenticação | Selecione o parâmetro de autenticação para a solicitação de autenticação. Você pode selecionar as opções padrão ou criar um novo parâmetro de autenticação: * x-sn-apikey: cabeçalho de autenticação * x-sn-apikey: cabeçalho do parâmetro de consulta {#configure-api-key__ul_vpl_bwm_nzb} |
      [Tabela 1. Perfis de autenticação da chave de API]

      {#configure-api-key__table_pdg_vvm_nzb}  
      Nota:  
      A opção selecionada precisa ser definida na chamada REST como parte do cabeçalho de autenticação ou do parâmetro de consulta.  
      Nota:  
      Para adicionar um prefixo para a chave de API, abra o arquivo do parâmetro de autenticação que você selecionou e especifique o campo Prefixo.
   5. Envie o formulário.
2. Crie uma chave de REST API.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de APIChave de REST API.
   2. Selecione Novo.
   3. No formulário, preencha os campos:  
      {#configure-api-key__table_ehg_jtx_mzb__entry__2}

      | Campo | Descrição |
      |-|-|
      | Nome | Nome para identificar a chave de REST API |
      | Descrição | Descrição da chave de REST API. |
      | Ativo | Status da chave de REST API. |
      | Usuário | Usuário associado à chave de REST API. Use o ícone de pesquisa para selecionar o usuário. |
      | Escopo de autenticação | Opção para adicionar escopo de autenticação para gerenciar a autoridade da chave de REST API. |
      | Token | A chave de REST API gerada pela Now Platform. Copie a chave para usar como parte da chamada de REST API no Cabeçalho ou no Parâmetro de consulta. |
      | Vencimento | Prazo após o qual a credencial não é mais válida. Um valor vazio significa que não há vencimento. Nota: Para obter mais informações sobre a expiração do token, consulte [Como limpar o vencimento de tokens](https://servicenow-prod.fluidtopics.net/POezrzZygfnixle8oqDT0A "Detalhes sobre como limpar o vencimento de tokens usando diferentes propriedades do sistema."). |
      [Tabela 2. Chave de API]

      {#configure-api-key__table_ehg_jtx_mzb}
   4. Envie o formulário.
   5. Abra o registro que foi criado para exibir o token gerado por Now Platform para o usuário.  
   {#configure-api-key__substeps_j4w_dtx_mzb}
3. Crie uma política de acesso de REST API.
   1. Navegar até TudoServiços web do sistemaPolíticas de acesso de REST API.
   2. Selecione Novo.
   3. No formulário, preencha os campos.  
      {#configure-api-key__table_d4x_w45_d4b__entry__2}

      | 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. |
      | Aplicação | Escopo da aplicação. |
      | Global | Habilite este campo para aplicar a política de autenticação a todos os métodos, versões e recursos para a API. Nota: A autenticação baseada em token não é permitida na política da REST API global. |
      | Aplicar a todos os métodos | Habilite este campo para aplicar a política de autenticação para a API a todos os métodos, versões e recursos para a API. |
      | Aplicar a todos os recursos | Habilite este campo para aplicar a política de autenticação para a API a todas as versões. |
      | Aplicar a todas as versões | Habilite este campo para aplicar a política de autenticação para a API a todos os recursos. |
      [Tabela 3. Políticas de acesso de API]

      {#configure-api-key__table_d4x_w45_d4b}
   4. Adicione o perfil de autenticação de API que foi criado.
   5. Envie o formulário.

   {#configure-api-key__substeps_ypz_h5x_mzb}  
   Você pode enviar a chamada de REST API com o x-sn-apikey (token) que foi gerado por Now Platform durante a criação da chave de API no cabeçalho ou no parâmetro de consulta com base na configuração para autenticação.  
   Aviso:  
   Use a solicitação POST ao enviar informações confidenciais para o servidor.