Ir para o conteúdo

Fonte de dados REST no Jitterbit App Builder

Introdução

A fonte de dados REST permite que você conecte o App Builder a vários servidores REST (incluindo outras instâncias do App Builder) ou para uso com objetos REST. A configuração de um servidor de fonte de dados REST é usada em todos os endpoints REST.

A configuração de uma fonte de dados REST envolve as seguintes etapas:

  1. Criar um servidor de fonte de dados REST.

  2. Configurar cabeçalhos de solicitação.

  3. Configurar parâmetros da string de consultar.

  4. Criar endpoints REST para cada método de API que está sendo chamado.

  5. Adicionar endpoints REST.

  6. (Opcional) Substituir tipos de conteúdo de solicitação/resposta de endpoint.

  7. (Opcional) Configurar paginação de resposta.

Desde o App Builder 4.45, você também pode criar um endpoint REST a partir de um documento OpenAPI.

Crie um servidor de dados REST

Para criar um servidor de dados REST, siga estes passos:

  1. Selecione IDE > Servidores de dados.

  2. Clique no botão + Servidor.

  3. Na seção Configurações do servidor, defina os seguintes campos:

    • Nome do servidor: Insira um nome para o servidor REST.

    • Tipo: Abra o menu, localize e selecione REST API.

    • Url: Digite a URL do servidor ao qual deseja se conectar.

      Nota

      Os Endpoints são configurados na próxima seção.

    • Tipo de Conteúdo de Solicitação e Tipo de Conteúdo de Resposta: Selecione os tipos de conteúdo de solicitação e resposta. (Normalmente, os servidores REST se comunicam via JSON.)

  4. (Opcional) Expanda a seção Configurações de segurança e defina o seguinte:

    • Provedor de segurança: Abra o menu, localize e selecione o provedor de segurança necessário.

    • Nome de usuário: Digite o nome de usuário para o serviço do provedor de segurança.

    • Senha: Digite a senha para o serviço do provedor de segurança.

    Dica

    A maioria das APIs REST usa uma chave de API no cabeçalho (configurada em uma seção posterior).

  5. (Opcional) Descrição: Insira uma descrição para este servidor.

  6. Clique no botão Salvar e feche a caixa de diálogo.

Você deve ver seu Servidor de Dados REST na lista de Servidores de Dados.

Configurar cabeçalhos de solicitação

A maioria dos serviços REST exige que você passe uma chave de API usando o cabeçalho de solicitação.

Para configurar o cabeçalho da solicitação, siga estas etapas:

  1. Selecione IDE > Servidores de dados.

  2. Clique no botão Detalhes para seu novo servidor de dados REST.

  3. No painel Parâmetros do Serviço Web, clique no botão + Parâmetro. Uma nova linha aparecerá no painel. Defina os valores da seguinte forma:

    • Tipo: Abra o menu e selecione Cabeçalho.

    • Nome: Insira o nome do parâmetro do cabeçalho. (Para servidores REST do App Builder, a chave da API é passada usando "X-API-Key".)

    • Valor: Insira o valor do parâmetro do cabeçalho.

    • Tipo de uso: Abra o menu e selecione o tipo de uso para este parâmetro.

  4. Clique no ícone para salvar o parâmetro.

Configurar parâmetros de string de consultar

Se você tiver parâmetros de string de consultar comuns para usar em todos os pontos de extremidade, poderá configurá-los seguindo as seguintes etapas:

  1. Selecione IDE > Servidores de dados.

  2. Clique no botão Detalhes para seu novo servidor de dados REST.

  3. No painel Parâmetros do Serviço Web, clique no botão + Parâmetro. Uma nova linha aparecerá no painel. Defina os valores na linha da seguinte forma:

    • Tipo: Consulta

    • Nome: Insira o nome do parâmetro da string de consultar.

    • Valor: Insira o valor do parâmetro da string de consultar.

    • Tipo de uso: Abra o menu e selecione o tipo de uso para este parâmetro.

  4. Clique no Ícone para salvar o parâmetro do servidor web.

Adicionar endpoints REST

Depois que seu servidor de dados REST estiver configurado, você poderá adicionar endpoints de API.

Para adicionar um endpoint, siga estas etapas:

  1. Selecione IDE > Servidores de dados.

  2. Clique no botão Detalhes para seu novo servidor de dados REST.

  3. No painel Endpoints, clique no botão + Endpoint. Uma nova linha aparecerá no painel. Defina os valores na linha da seguinte forma:

    • Nome: Digite o nome do endpoint.

    • Endpoint: Insira o endpoint. (Este valor é anexado ao URL do servidor de dados REST definido em uma seção anterior.)

    • Método: Selecione o método HTTP para o endpoint.

  4. Clique no ícone para salvar o endpoint.

Substituir tipos de conteúdo de solicitação/resposta de endpoint

O valor padrão para os tipos de conteúdo Solicitação e Resposta é herdado do tipo de conteúdo do servidor. Os valores de tipo de conteúdo disponíveis são os seguintes:

  • Arquivo
  • Formulário
  • JSON
  • Multipart
  • Texto Simples
  • XML

Para substituir os tipos de conteúdo de solicitação ou resposta do endpoint, siga estas etapas:

  1. No painel Endpoints, selecione Mais > Caso Extremo. A caixa de diálogo Caso Extremo de Endpoint é aberta.

  2. Clique no botão Editar.

  3. Na seção Tipo de conteúdo, defina valores para o seguinte:

    • Solicitação: Abra o menu e selecione o tipo de conteúdo da solicitação de substituição.

    • Resposta: Abra o menu e selecione o tipo de conteúdo de resposta predominante.

  4. Clique no botão Salvar e feche a caixa de diálogo.

  5. Para revisar a consultar proposta, clique no botão Descobrir. A caixa de diálogo Endpoint será aberta.

  6. Na caixa de diálogo Endpoint, clique no botão Descobrir para executar a consultar. Esta ação faz o seguinte:

    • Gera parâmetros de entrada para qualquer entrada de amostra inserida.

    • Gera tabelas de saída para quaisquer dados retornados pelo endpoint.

  7. Feche a caixa de diálogo Endpoint.

  8. Na seção Endpoints, clique no botão Testar Conexão e, em seguida, clique no botão Prosseguir para chamar o endpoint. Se os parâmetros de entrada estiverem definidos, seus valores de teste serão enviados.

Configurar paginação de resposta

Para configurar a paginação de resposta, siga estes passos:

  1. Selecione IDE > Servidores de Dados.

  2. Clique no botão Detalhes do seu novo servidor de dados REST.

  3. No painel Parâmetros do Serviço Web, clique no botão + Parâmetro. Uma nova linha aparecerá no painel. Defina os valores na linha da seguinte forma:

    • Tipo: Consulta

    • Nome: Insira a string esperada pelo serviço. (Exemplos incluem Limit, _limit.)

    • Valor: Insira o número de registros por página.

    • Tipo de Uso: Abra o menu e selecione Limite de Solicitações.

  4. Clique em ícone para salvar o parâmetro.

  5. Clique no botão + Parâmetro. Uma nova linha aparecerá no painel. Escolha um dos seguintes métodos de paginação e defina os valores conforme a seguir:

    • Deslocamento da Solicitação: Faz com que o serviço ignore um número de registros. Defina os valores na linha da seguinte forma:

      • Tipo: Consulta

      • Nome: Deslocamento da Solicitação

      • (Opcional) Valor: Insira o número de registros a serem ignorados.

      • Tipo de Uso: Abra o menu e selecione Solicitar Deslocamento.

    • Solicitar Número de Página: Busque um número de página específico. Defina os valores na linha da seguinte forma:

      • Tipo: Consulta

      • Nome: Solicitar Número de Página

      • (Opcional) Valor: Insira o número da página a ser buscada.

      • Tipo de Uso: Abra o menu e selecione Solicitar número de página.

    • Próximo Token: Busca registros de um ponto especificado. Defina os valores na linha da seguinte forma:

      • Tipo: Consulta

      • Nome: Próximo Token

      • (Opcional) Valor: Insira a chave de início do registro.

      • Tipo de Uso: Abra o menu e selecione Próximo Token.

  6. Clique em ícone para salvar o parâmetro.