Crie e configure uma REST API com script para sua integração de bate-papo personalizada

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

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

    Antes de Iniciar

    Mapeie 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 da web do sistema > Serviços web com script > Scripted REST APIs.
      2. Clique em Novo.
      3. No formulário, preencha os campos.
        Campo Descrição
        Nome Nome da sua API. Por exemplo, Adaptador de bate-papo do app móvel ACME .
        ID da API Identificador de API. Por exemplo, acme_chat .
        Política de proteção A política de proteção do script.
        • Somente leitura : O script só pode ser visualizado.
        • 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 está selecionado por padrão.
        Namespace da API O namespace ao qual a API pertence. O valor depende do escopo da aplicação atual.
      4. Clique em Enviar.
      5. Opcional: Abra o novo registro, navegue até Links relacionados e clique em Habilite o controle de versão e clique em OK .
        Clique em Atualizar para salvar suas mudanças.
    2. Adicione um recurso REST com script à sua nova REST API.
      O recurso REST com script define a definição da REST API com script que você criou.
      1. Abra o registro da REST API que você criou e navegue até Recursos em Links relacionados .
      2. Clique em Novo.
        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 REST da API. Por exemplo, Bate-papo DO ACME .
        Versão da API Versão da API. Por exemplo, v1.

        Este campo será exibido somente se você tiver habilitado o controle de versão para a REST API.
        Ativo Opção para tornar o recurso REST ativo.
        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 : O script só pode ser visualizado.
        • Protegido : Usuários com permissões de senha podem editar o script.
        Exemplo de um recurso REST com 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 negociação de segurança e conteúdo para seu recurso REST com script.
      Escolha definir formatos de autenticação e solicitação. Se sua integração personalizada não depender de autenticação, você pode removê-la da seguinte forma.
      1. No novo registro do recurso REST com script, navegue até Segurança .
      2. Limpar Requer autenticação .
      3. Clique em Negociação de conteúdo e selecione Substituir formatos de solicitação compatíveis .
      4. Clique em Enviar.
    4. Defina limites de taxa da REST API para definir a taxa de solicitações de entrada.
      1. Navegar até Tudo > Serviços da web do sistema > REST > Regras de Limite de Taxa.
      2. Clique em Novo.
      3. No formulário, preencha os campos.
        Campo Descrição
        Nome Nome exclusivo da regra de limite de taxa.
        REST API REST API que você criou em uma etapa anterior.
        Versão 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 Caixa de seleção 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 você as cria. Você pode desativar regras de limite de taxa para parar de impor um limite de taxa ou ativar regras de limite de taxa para retomar a imposiçã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, a Now Platform redefinirá a contagem de solicitações para 0 e excluirá 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

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