Ir para o conteúdo

Fonte de dados REST no Jitterbit App Builder

Introdução

A fonte de dados REST permite conectar 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 é utilizada em todos os endpoints REST.

Configurar uma fonte de dados REST envolve os seguintes passos:

  1. Criar um servidor de fonte de dados REST.

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

  3. Configurar corpo da requisição.

  4. Configurar parâmetros de string de consulta.

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

  6. Adicionar endpoints REST.

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

  8. (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.

Criar 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: Selecione REST API.

    • URL: Insira a URL do servidor ao qual se conectar.

      Nota

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

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

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

    • Provedor de Segurança: Selecione o provedor de segurança necessário.

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

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

    Dica

    A maioria das APIs REST utiliza uma chave de API no cabeçalho (configurada na próxima seção).

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

  6. Clique no botão Salvar e, em seguida, feche o diálogo. Você deve ver seu novo servidor de dados REST na lista.

Configurar cabeçalhos de solicitação

A maioria dos serviços REST exige que você passe uma chave de API usando o cabeçalho da solicitação. Para configurar o cabeçalho da solicitação, siga estas etapas:

  1. Selecione IDE > Servidores de Dados.

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

  3. Na janela pop-up Servidor, em Configurações do Servidor, clique no ícone Endpoints .

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

    • Tipo: 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: (Opcional) Selecione o tipo de uso para este parâmetro.

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

Configurar corpo da solicitação

Para alterar como a carga útil é estruturada ao usar métodos POST ou PUT, siga estas etapas:

  1. No painel Endpoints, selecione Mais > Caso de Bordas. A janela de diálogo Caso de Bordas do Endpoint é aberta.

  2. Clique no botão Editar.

  3. Na seção Solicitação, defina Corpo da Solicitação para um dos seguintes valores:

    • Objeto: (Padrão) A carga útil é enviada como um único objeto JSON. Use isso ao criar ou atualizar um único registro.

      Exemplo
      {
  "id": 123,
  "name": "A single record"
}

    • Array: A carga útil é enviada como um array JSON de objetos. Use isso para enviar um lote de vários registros em uma única solicitação.

      Exemplo
      [
  { "id": 123, "name": "First record" },
  { "id": 124, "name": "Second record" }
]

    • Ignorar Raiz: Para cargas úteis que estão envolvidas em um objeto de nível superior, esta opção ignora o invólucro e envia o primeiro elemento filho como a carga útil. Isso é útil para cenários de 'drill down'.

      Por exemplo, se o sistema gerar um payload com um wrapper data, Skip Root envia apenas o conteúdo dentro de data.

      Exemplo de Payload Enviado
      {
  "id": 123,
  "name": "The actual record"
}

  4. Clique no botão Salvar e, em seguida, feche o diálogo.

Configurar parâmetros de string de consulta

Se você tiver parâmetros de string de consulta comuns para usar em diferentes pontos finais, pode configurá-los com os seguintes passos:

  1. Selecione IDE > Servidores de Dados.

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

  3. Na janela pop-up Servidor, em Configurações do Servidor, clique no ícone Endpoints .

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

    • Tipo: Selecione Consulta.

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

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

    • Tipo de Uso: (Opcional) Selecione o tipo de uso para este parâmetro.

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

Adicionar endpoints REST

Uma vez que seu Servidor de Dados REST tenha sido configurado, você pode adicionar endpoints de API.

Para adicionar um endpoint, siga estes passos:

  1. Selecione IDE > Servidores de Dados.

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

  3. Na janela pop-up Servidor, em Configurações do Servidor, clique no ícone Endpoints .

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

    • Nome: Insira o nome do endpoint.

    • Endpoint: Insira o endpoint. (Este valor é anexado à URL do Servidor de Dados REST definida em uma seção anterior.)

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

  5. Clique no ícone para salvar o endpoint.

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

O valor padrão para os tipos de conteúdo de 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 de Bordas. A caixa de diálogo Caso de Bordas do Endpoint é aberta.

  2. Clique no botão Editar.

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

    • Solicitação: Selecione o tipo de conteúdo de solicitação que está substituindo.

    • Resposta: Selecione o tipo de conteúdo de resposta que está substituindo.

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

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

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

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

    • Gera tabelas de saída para qualquer dado retornado 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 são enviados.

Configurar paginação de resposta

Para configurar a paginação de resposta, siga estas etapas:

  1. Selecione IDE > Servidores de Dados.

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

  3. Na janela pop-up Servidor, em Configurações do Servidor, clique no ícone Endpoints .

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

    • Tipo: Selecione 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ção.

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

  6. Clique no botão + Parâmetro. Uma nova linha aparece no painel. Escolha um dos seguintes métodos de paginação e defina os valores conforme abaixo:

    • Deslocamento da Solicitação: Faça o serviço pular um número de registros. Defina os valores na linha conforme abaixo:

      • Tipo: Consulta

      • Nome: Deslocamento da Solicitação

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

      • Tipo de Uso: Abra o menu e selecione Deslocamento da Solicitação.

    • Número da Página da Solicitação: Busque um número de página específico. Defina os valores na linha conforme abaixo:

      • Tipo: Consulta

      • Nome: Número da Página da Solicitação

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

      • Tipo de Uso: Abra o menu e selecione Número da página da solicitação.

    • Token Seguinte: Busque registros a partir de um ponto especificado. Defina os valores na linha conforme abaixo:

      • Tipo: Consulta

      • Nome: Token Seguinte

      • (Opcional) Valor: Insira a chave para o registro a partir do qual começar.

      • Tipo de Uso: Abra o menu e selecione Token Seguinte.

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