Ir para o conteúdo

Crie um endpoint HTTP hospedado no Jitterbit Design Studio

Visão geral

Um Endpoint HTTP hospedado representa uma URL com uma ou mais operações associadas a ela. Quando a URL é acessada, as operações configuradas são acionadas com os dados da solicitação como entrada (se houver). O endpoint pode ser configurado para retornar um arquivo de destino ou o conteúdo de um elemento de dados como resposta.

Nota

O Endpoint HTTP hospedado pode ser implementado somente em agentes privados. Se você estiver executando em agentes de nuvem, precisará usar o recurso de API personalizado para chamar uma operação. Para configurar uma API personalizada, consulte API Manager para obter informações adicionais.

Crie um endpoint HTTP hospedado

Siga estas etapas para criar um Endpoint HTTP hospedado:

  1. Se você ainda não o fez, faça login no Jitterbit Studio.
  2. Certifique-se de ter aberto o projeto apropriado no qual deseja criar o novo Hosted HTTP Endpoint.
  3. Crie e teste as operações que você deseja acionar com o Endpoint HTTP hospedado.
  4. Clique com o botão direito do mouse no nó Hosted HTTP Endpoints na Árvore de Projetos e escolha New Hosted HTTP Endpoint ou selecione New no Menu Arquivo e escolha New Hosted HTTP Endpoint no submenu. Uma nova aba intitulada "New Hosted HTTP Endpoint" aparecerá no painel direito:

    anexo

  5. Preencha as propriedades do HTTP Endpoint:

    1. O Nome do seu endpoint deve ser exclusivo dentro do seu projeto.

    2. Endpoint URL é a URL que você quer que este endpoint escute. Por exemplo, se você digitar "company/po_import", o endpoint será acionado quando a URL "http://[server name]:[server port]/company/po_import" é solicitado.

      1. O nome do servidor é o servidor no qual o agente privado está instalado. Se você tiver um balanceador de carga ou firewall na frente do seu agente privado, então este é o IP/nome do host que está configurado para se comunicar com o agente privado.

      2. A porta do servidor para HTTP é 46908.

      3. Se você estiver criando uma URL HTTPS (em vez de HTTP), precisará configurar o SSL no Jitterbit Apache no agente privado Jitterbit. Consulte estes links para obter informações adicionais:

      4. A porta do servidor para HTTPS é 46909.

    3. Operações para acionar é uma lista das operações que você deseja acionar com este endpoint. Pelo menos uma operação deve ser especificada. Para adicionar uma operação, clique no botão Adicionar operação. Uma lista de operações disponíveis será apresentada. Selecione uma ou mais operações e clique em OK. Se você selecionar uma operação existente e clicar em Editar operação, a operação selecionada aparecerá em uma nova janela ou aba. Para remover uma ou várias operações da lista de operações a serem acionadas, selecione a(s) operação( ões) e clique em Remover operações.

    4. Cada operação pode ser acionada de forma síncrona ou assíncrona. Para cada operação, selecione o modo apropriado no menu suspenso. Se você quiser usar o resultado de uma operação como resposta, ela deve ser executada de forma síncrona. As operações assíncronas são apenas adicionadas à fila de operação para processamento futuro.

    5. Se você quiser que o alvo final de uma operação seja retornado como resposta, marque a caixa de seleção Alvo Final Como Resposta para a operação que você deseja usar. Apenas uma operação pode ter essa opção marcada.

    6. Em Request Settings, você pode, opcionalmente, escolher que os dados da solicitação sejam gravados em uma variável global. Se não for necessário, deixe este campo vazio. Por exemplo, se você digitar a string request neste campo, os dados da solicitação estarão acessíveis em scripts e mapeamentos como $request ou Get("request").Em Configurações de resposta, o comportamento de resposta é configurado. O padrão é Sem resposta. Se você precisar retornar dados como parte da resposta, poderá usar o destino final de uma operação ou dados gravados em um elemento de dados global como a resposta. Marque o botão de opção apropriado e selecione uma operação ou insira o nome de um elemento de dados global.

  6. Por padrão, um Hosted HTTP Endpoint requer um usuário autenticado. O usuário autentica usando autenticação HTTP e todas as operações acionadas devem ter o sinalizador de permissão de execução definido para o usuário autenticado. Se você quiser que qualquer pessoa possa acionar o endpoint ou se você estiver implementando a autenticação por conta própria, o usuário Anonymous deve ter permissão de execução na operação. As operações sempre são executadas como o proprietário da operação.

  7. Implante seu projeto. Assim que o Hosted HTTP Endpoint for implantado, ele escutará as solicitações de entrada na URL configurada.

Elementos de dados globais

Esses elementos de dados globais são preenchidos quando um Endpoint HTTP hospedado é acessado:

  1. jitterbit.networking.http.request.header.HeaderName

    Contém os cabeçalhos HTTP incluídos na solicitação. Por exemplo, o cabeçalho Content-Type é gravado no elemento de dados global $jitterbit.networking.http.request.header.content_type. NOTA: Use qualquer um $jitterbit.networking.http.request.header.content_type ou Get("jitterbit.networking.http.request.header.content-type") para recuperar o valor.

  2. jitterbit.networking.http.query.ParameterName

    Contém os parâmetros de consultar de URL, se houver. Se a URL acessada for http://server:port/company/po_import?po_id=dlsho394&uid=arcade, então $jitterbit.networking.http.query.po_id terá o valor "dlsho394" e $jitterbit.networking.http.query.uid terá o valor "arcade".

  3. jitterbit.networking.peer.ip

    Contém o endereço IP da máquina de chamada.

Esses elementos de dados globais podem ser definidos para modificar o comportamento de um Endpoint HTTP hospedado:

  1. jitterbit.networking.http.response.content_type

    Substitui o cabeçalho de resposta Content-Type padrão. O cabeçalho Content-Type padrão é definido seguindo estas regras: Se um destino de operação for a resposta, o cabeçalho Content-Type será definido como "text" para um destino de texto e "text/xml" para um destino XML. Se o endpoint retornar o conteúdo de um elemento de dados como a resposta, o cabeçalho Content-Type será definido como "text/html". Se o endpoint não estiver configurado para retornar dados de resposta, o cabeçalho Content-Type não será definido. Defina este elemento de dados global para substituir esses padrões.