Criar e configurar uma REST API com script para a integração de bate-papo personalizada.

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura

    • Crie uma REST API com script, adicione um recurso REST com script, defina a segurança e a negociação de conteúdo e defina os limites de taxa da REST API.

    Antes de Iniciar

    Mapear controles avançados para o canal em sua integração de bate-papo personalizada.

    Função necessária: administrador

    Procedimento

    1. Crie a REST API
      1. Navegar até Tudo > Serviços web do sistema > Serviços web com script > Scripted REST APIs.
      2. Clique em Nova.
      3. No formulário, preencha os campos.
        Campo Descrição
        Nome Nome da sua API. Por exemplo, Adaptador de bate-papo de aplicativo para celular ACME.
        ID da API Identificador da API. Por exemplo, acme_chat.
        Política de proteção A política de proteção do script.
        • Somente leitura: oscript só pode ser exibido.
        • Protegido: usuários com permissões de senha podem editar o script.
        Aplicação A aplicação que contém o registro de script. Global é selecionado por padrão.
        Namespace da API O namespace ao qual a API pertence. O valor depende do escopo de aplicação atual.
      4. Clique em Enviar.
      5. Opcional: Abra o novo registro, navegue até Links relacionados, clique em Habilitar controle de versõese, em seguida, clique em OK.
        Clique em Atualizar para salvar suas mudanças.
    2. Adicione um recurso REST de script à sua nova API REST.
      O recurso REST de script determina a definição de API REST com script que você criou.
      1. Abra o registro da REST API criado e navegue até a guia Recursos em Links relacionados.
      2. Clique em Nova.
        Recupere a carga da solicitação e grave-a em uma fila híbrida.
      3. No formulário, preencha os campos.
        Campo Descrição
        Definição da API Nome da API primária.
        Aplicação A aplicação que contém o registro de script.
        Nome Nome do Recurso de API REST. Por exemplo, bate-papo da ACME.
        Versão da API Versão da API Por exemplo, v1.

        Esse campo só será exibido se o controle de versões para a REST API tiver sido habilitado.
        Ativo Opção para ativar o recurso REST.
        Método HTTP Método HTTP, como POST, GET e assim por diante.
        Caminho relativo Caminho relativo para o recurso
        Script Script para o recurso REST.
        Política de proteção A política de proteção do script.
        • Somente leitura: oscript só pode ser exibido.
        • Protegido: usuários com permissões de senha podem editar o script.
        Exemplo de um Recurso REST de script:
        (function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
    var body = request.body;
    var queryParams = request.queryParams; // incoming content is application/x-www-form-urlencoded in this example    
    // get the provider application sys id. this can be done via a glide query using incoming data such as where the original message is being sent to. or it can be hard-coded such as this example.
    var providerAppId = "a5f8b75b7377001042281188caf6a73a";    
    // the time of receipt is recorded for analytics purposes
    var d = new Date();
    var logTime = d.getTime();    
    // add this message to the VA Server queue for processing
    var queued = sn_cs.VASystemObject.enqueueCustomAdapterMessage(providerAppId, JSON.stringify(queryParams), JSON.stringify(request.headers), logTime);
    if (queued == false) {
	response.setError(new sn_ws_err.BadRequestError('Failed to process the request.'));
    }
})(request, response);
​
    3. Defina a segurança e a negociação de conteúdo para o recurso REST de script.
      Escolha para definir formatos de autenticação e de solicitação. Se a integração personalizada não depende de autenticação, convém removê-la, da seguinte forma.
      1. No novo registro do Recurso REST de script, navegue até a guia Segurança.
      2. Limpe o campo Requer autenticação.
      3. Clique na guia Negociação de conteúdo e, em seguida, selecione Substituir formatos de solicitação compatíveis.
      4. Clique em Enviar.
    4. Defina os limites de taxa da REST API para definir a taxa de solicitações de entrada.
      1. Navegar até Tudo > Serviços web do sistema > REST > Regras de Limite de Taxa.
      2. Clique em Nova.
      3. No formulário, preencha os campos.
        Campo Descrição
        Nome Nome exclusivo para a regra de limite de taxa.
        REST API REST API criada em uma etapa anterior.
        Versão Versão da REST API. Os valores listados dependem da REST API selecionada.
        Recurso Recurso para a versão especificada. Os valores listados dependem da versão selecionada.
        Ativo Marque a caixa para indicar que a regra de limite de taxa está ativa.

        As regras de limite de taxa são ativadas por padrão assim que são criadas. Você pode desativar as regras de limite de taxa para interromper a aplicação de um limite de taxa ou para ativar regras de limite de taxa para retomar a aplicação de um limite de taxa.
        Limite de solicitação por hora Número máximo de solicitações permitidas por hora.
        Nota:
        Sempre que você atualizar o valor deste campo, o ServiceNow AI Platform redefine a contagem de solicitações como 0 e exclui todas as violações da hora atual.
        Aplicar a Usuários restritos por esta regra. Selecione Todos os usuários.
      4. Clique em Enviar.

    O que Fazer Depois

    Criar os scripts de ação para sua integração de bate-papo personalizada