Como criar uma inclusão de script de integração para aplicações de transportadora de terceiros

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura

    • Para se integrar a uma instância ServiceNow, uma aplicação de transportadora de terceiros deve ter uma inclusão de script que estende o script ITAMshipmentIntegration da classe base em sua instância ServiceNow para receber o número de acompanhamento da remessa da instância ServiceNow do cliente e responder com a transportadora Detalhes relacionados a.

    Considere o seguinte ao criar a inclusão de script:
    • Certifique-se de que a inclusão de script seja acessível a partir do Gestão de ativos escopo da aplicação comum, ajustando as seguintes configurações no registro de recursos da aplicação:
      • Defina o campo Acessível de como Todos os escopos da aplicação.
      • Defina o campo Acesso do solicitante como Nenhum para garantir que o acesso do solicitante não seja restrito.
    • O código para comunicação com a instância ServiceNow do cliente com base no número de acompanhamento deve ser incluído na função fetchShipmentInfo.
    • Quando a API é invocada no modo de teste para validar a conexão com a instância ServiceNow do cliente, a resposta de retorno do método fetchShipmentInfo deve ser um objeto JSON com o código de resposta HTTP e a mensagem de resposta, da seguinte forma:
      {
httpResponseCode: 200, httpResponseMessage: ‘SUCCESS’
}
    • Quando não estiver no modo de teste, consulte as remessas e invoque o método processResponse com o seguinte formato de resposta:
      [
{
trackingNumber: ‘’,
deliveryDate: ‘’,
pickupDate: ‘’,
packageStatus: ‘’.
statusDetail: ‘’,
trackingURL: ‘’,
parcelWeight: ‘’,
deliveryServicesCost: ‘’,
currency: ‘’
}
	]

    Códigos de exemplo de inclusão de script ITAMshipmentIntegration

    Figura 1. Exemplo de inclusão de script ITAMshipmentIntegration com a função processResponse padrão fornecida pela aplicação Gestão de ativos de TI
    Inclusão de script ITAMshipmentIntegration com função processResponse ITAM
    Figura 2. Exemplo de inclusão de script ITAMshipmentIntegration com função processResponse personalizada
    Inclusão de script ITAMshipmentIntegration com função processResponse personalizada

    Função fetchShipmentInfo

    A função fetchShipmentInfo recebe os números de acompanhamento da instância ServiceNow do cliente e invoca a API da transportadora para buscar os detalhes da remessa para todos os números de acompanhamento. Nesta função, você deve definir a lógica de negócios que permite que seus clientes se comuniquem com as APIs da operadora com base nos números de acompanhamento. Esta função processa a resposta recebida da API da transportadora e invoca a função de pós-processamento.

    Função processResponse

    A função processResponse recebe a resposta da API da transportadora e atualiza os registros de remessa com os seguintes detalhes relacionados à transportadora:
    • Link da transportadora
    • Status da transportadora
    • Detalhe do status da transportadora
    • Data de coleta da transportadora
    • Data de entrega da transportadora
    • Moeda
    • Custo dos serviços de entrega
    • Peso do pacote

    Você pode usar a função processResponse padrão ou definir uma lógica personalizada para atualizar os registros de remessa.