Atividade HTTP POST
Introdução
Uma atividade HTTP POST, utilizando sua conexão HTTP, substitui um recurso existente em um serviço acessível pelo protocolo HTTP ou HTTPS, e pode ser usada tanto como uma fonte (para fornecer dados em uma operação) quanto como um destino (para consumir dados em uma operação).
Importante
Com o lançamento do conector HTTP v2, recomendamos converter conexões e atividades HTTP existentes para HTTP v2. Saiba mais sobre os benefícios do conector HTTP v2 em nosso post no blog sobre HTTP v2 ou veja uma comparação das funcionalidades dos conectores HTTP e HTTP v2.
A intenção de longo prazo da Jitterbit é descontinuar o conector HTTP, o que será anunciado de acordo com a política de fim de vida da Jitterbit. No momento, não há um cronograma para descontinuação e o conector HTTP continua totalmente suportado. Recomendamos que você converta conexões e atividades HTTP existentes para HTTP v2 sempre que possível.
Criar uma atividade HTTP Post
Uma instância de uma atividade HTTP POST é criada a partir de uma conexão HTTP usando seu tipo de atividade POST.
Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade em Reutilização de componentes.
Uma atividade HTTP POST existente pode ser editada a partir destes locais:
- A tela de design (veja Menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).
Configurar uma atividade HTTP Post
Siga estas etapas para configurar uma atividade HTTP POST:
-
Etapa 1: Insira um nome e especifique as configurações
Forneça um nome para a atividade e especifique a URL, os parâmetros da solicitação e os cabeçalhos da solicitação. -
Etapa 2: Forneça o esquema da solicitação
Forneça um esquema de solicitação personalizado. -
Etapa 3: Forneça o esquema da resposta
Forneça um esquema de resposta personalizado. -
Etapa 4: Revise os esquemas de dados
Os esquemas de solicitação e resposta configurados (se fornecidos) são exibidos.
Etapa 1: Insira um nome e especifique as configurações
Nesta etapa, forneça um nome para a atividade e especifique a URL, os parâmetros da solicitação e os cabeçalhos da solicitação. Cada elemento da interface do usuário desta etapa é descrito abaixo.
Dica
Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [
no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.
Importante
Campos nas tabelas exibem o ícone de variável apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.
-
Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade HTTP POST e não deve conter barras
/
ou dois pontos:
. -
Verbo HTTP: O verbo HTTP não pode ser alterado.
Nota
Para um HTTP POST usado como fonte, uma solicitação vazia é enviada para a URL e a resposta é usada como a fonte.
Para um HTTP POST usado como destino, virtualmente qualquer tipo de carga útil pode ser incluído, mas deve ser compreendido pelo servidor web que a está recebendo. Uma resposta é retornada com base na solicitação HTTP e é analisada pelo Harmony. Se a resposta indicar sucesso, nada mais é feito. Se uma mensagem de erro for recebida, ela é usada como parte do processo de registro de erros para a operação e é relatada nos logs de operação.
-
Caminho: Insira um caminho e/ou parâmetros de consulta que devem ser anexados à URL base que foi especificada na configuração da conexão HTTP. Se estiver fornecendo parâmetros de consulta, especifique-os como faria em um navegador web, como
/queryrecord?id=10
. -
URL: A URL criada como uma concatenação da URL base e do caminho inserido acima é fornecida para referência. Para editar a URL, faça alterações na URL base na conexão HTTP ou no caminho inserido acima.
-
Parâmetros da Solicitação: Clique no botão Adicionar para adicionar uma linha e, em seguida, insira um Nome e Valor específicos para os parâmetros solicitados. Clique no botão Remover para excluir uma linha existente. Os parâmetros de solicitação fornecidos serão automaticamente codificados em URL.
-
Cabeçalhos da Solicitação: Clique no botão Adicionar para adicionar uma linha e, em seguida, insira um Nome e Valor específicos para as informações do cabeçalho solicitado. Clique no botão Remover para excluir uma linha existente.
-
Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.
Etapa 2: Fornecer o esquema de solicitação
Nesta etapa, você pode fornecer um esquema de solicitação personalizado (opcional).
-
Fornecer Esquema de Solicitação: O esquema de solicitação define a estrutura dos dados de solicitação que são usados pela atividade HTTP. Se um esquema de solicitação é necessário depende se a atividade é usada como o alvo de uma transformação e se o serviço web espera dados de solicitação estruturados (veja Uso de Esquemas). Para instruções sobre como completar esta seção da configuração da atividade, consulte Esquemas definidos em uma atividade.
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.
Etapa 3: Fornecer o esquema de resposta
Nesta etapa, você pode fornecer um esquema de resposta personalizado (opcional).
-
Fornecer Esquema de Resposta: O esquema de resposta define a estrutura dos dados de resposta que são usados pela atividade HTTP. Se um esquema de resposta é necessário depende se a atividade é usada como a fonte de uma transformação e se o serviço web retorna dados de resposta estruturados (veja Uso de Esquemas). Para instruções sobre como completar esta seção da configuração da atividade, consulte Esquemas definidos em uma atividade.
-
Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Etapa 4: Revisar os esquemas de dados
Os esquemas de solicitação e resposta configurados (se fornecidos) são exibidos.
-
Esquema de Dados: Se fornecido durante a configuração da atividade, os esquemas de dados de solicitação e/ou resposta são exibidos. Se a operação usar uma transformação, os esquemas de dados serão exibidos novamente mais tarde durante o processo de mapeamento de transformação, onde você pode mapear para campos de destino usando objetos de origem, scripts, variáveis, valores personalizados e mais. Você também pode definir esquemas diretamente em uma transformação.
-
Adicionar Plugin(s): Plugins são aplicativos fornecidos pela Jitterbit ou pelo usuário que estendem as capacidades nativas do Harmony. Para aplicar um plugin à atividade, clique para expandir esta seção e selecione a caixa de seleção ao lado do plugin a ser utilizado. Para instruções adicionais sobre como usar plugins, incluindo detalhes sobre a configuração de quaisquer variáveis necessárias usadas pelo plugin, consulte Plugins adicionados a uma atividade.
-
Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
-
Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Variáveis do Jitterbit que afetam a submissão HTTP
O sistema Harmony define certas variáveis globais que estão sempre disponíveis em um projeto, conhecidas como variáveis do Jitterbit ou como variáveis globais pré-definidas. As variáveis do Jitterbit listadas abaixo são particularmente úteis para atividades HTTP. Para mais informações sobre como usar variáveis do Jitterbit, veja Variáveis do Jitterbit.
Essas variáveis do Jitterbit afetam a forma como as submissões de origem HTTP são realizadas:
jitterbit.source.max_redirs
jitterbit.source.http.ssl_cert_id
jitterbit.source.http.transfer_timeout
Essas variáveis do Jitterbit afetam a forma como as submissões de destino HTTP são realizadas:
jitterbit.target.http.form_data
jitterbit.target.http.form_data.ContentType
jitterbit.target.http.form_data.filename
jitterbit.target.http.form_data.name
jitterbit.target.http.max_redirs
jitterbit.target.http.remove_trailing_linebreaks
jitterbit.target.http.ssl_cert_id
jitterbit.target.http.transfer_timeout
Próximos passos
Após configurar uma atividade HTTP POST, você pode usá-la dentro de uma operação ou script, conforme descrito abaixo. Você também pode querer configurar o particionamento para dividir os dados em partes menores para processamento.
Complete a operação
Após configurar uma atividade HTTP POST, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.
Uma vez que uma atividade HTTP POST tenha sido criada, as ações do menu para essa atividade estão acessíveis no painel do projeto nas abas Fluxos de Trabalho ou Componentes, e a partir da tela de design. Veja Menu de ações da atividade para mais detalhes.
Os padrões de operação com os quais as atividades HTTP POST podem ser usadas dependem se a atividade fornece dados (como uma fonte) ou recebe dados (como um destino) em uma operação, conforme descrito abaixo em Usado como fonte e Usado como destino.
Embora seja típico que as atividades HTTP POST sejam usadas como destino, é possível usar uma atividade HTTP POST como fonte. Se o serviço da web específico fornece esquemas de solicitação ou resposta para cada método determina se uma atividade pode ser usada como fonte ou destino, conforme descrito em Partes de uma operação em Criação e configuração de operações.
Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.
Usado como fonte
As atividades HTTP que são usadas como fonte podem ser utilizadas com estes padrões de operação:
- Padrão de arquivamento
- Padrão de transformação
- Padrão de arquivamento de dois destinos (como a primeira fonte apenas)
- Padrão de arquivamento HTTP de dois destinos (como a primeira ou segunda fonte)
- Padrão de duas transformações (como a primeira fonte apenas)
- Padrão de destino em massa do Salesforce
Outros padrões não são válidos usando atividades HTTP que são usadas como fonte.
Usado como um alvo
Atividades HTTP que são usadas como um alvo podem ser utilizadas com estes padrões de operação:
- Padrão de Arquivamento
- Padrão de Script
- Padrão de Transformação
- Padrão de Arquivamento com Dois Alvos (apenas como o segundo alvo)
- Padrão de Arquivamento HTTP com Dois Alvos (como o primeiro ou segundo alvo)
- Padrão de Duas Transformações (apenas como o segundo alvo)
- Padrão de Fonte em Massa do Salesforce
Outros padrões não são válidos usando atividades HTTP que são usadas como um alvo.
Usando atividades HTTP em scripts
Atividades HTTP também podem ser referenciadas em um script para uso com funções de script que utilizam um sourceId
ou targetId
como parâmetro, incluindo estas:
Funções Jitterbit
ArchiveFile
Base64EncodeFile
DBLoad
DBWrite
DeleteFile
DeleteFiles
DirList
FileList
FlushAllFiles
FlushFile
ReadFile
SfLookupAllToFile
WriteFile
Funções Jitterbit em JavaScript
Para mais detalhes sobre como referenciar atividades em scripts, veja Endpoints em Jitterbit Script ou Endpoints em JavaScript.
Usar chunking
Muitas APIs de serviços web têm limitações de tamanho. Se você estiver enfrentando limites de registro impostos pela API, pode ser interessante usar chunking para dividir os dados de origem em múltiplos pedaços. A transformação é então realizada em cada pedaço separadamente, com cada pedaço de origem produzindo um pedaço de destino. Os pedaços de destino resultantes se combinam para produzir o destino final.
Para instruções e melhores práticas sobre como usar chunking, veja Opções de operação.