Publicar o aplicativo Jitterbit App Builder como um endpoint de API REST

Introdução

No App Builder, é possível configurar um servidor de dados para ser uma API, permitindo que os dados do aplicativo sejam acessados por meio de uma chave de API. Esse recurso permite criar uma chave de API e endpoints em aplicativos. Este guia mostrará um exemplo usando dados do Northwinds e utiliza uma chave de API para se conectar a um endpoint criado em um aplicativo selecionado.

Como publicar um aplicativo do App Builder como um endpoint de API REST

1. Configurar uma chave de API do provedor de segurança

Para configurar uma chave de API do provedor de segurança para fornecer autenticação para acessar os endpoints, siga estas etapas:

1. Selecione IDE > Provedores de Segurança.

2. Clique em + Autenticação de Usuário no painel Autenticação de Usuário.

3. Atribua um Nome ao provedor. Por exemplo: Chave de API.

4. Selecione Chave de API como o valor do Tipo.

5. Marque para selecionar Habilitado.

6. Clique em Salvar.

Dependendo do seu caso de uso, você pode configurar as seguintes propriedades:

1. Se você deseja digitar a API na barra de localização do seu navegador para testes (não muito seguro), então:

   1. Clique em + Propriedade no painel Propriedades.

   2. Selecione AllowApiKeyInQueryString como o Parâmetro.

   3. Digite True como o Valor.

   4. Clique na marca de verificação para salvar o registro.

2. Se você estiver usando HTTP (não recomendado), adicione o seguinte:

   1. Clique em Criar.

   2. Selecione AllowInsecureHttp como o Parâmetro.

   3. Digite True para o Valor.

   4. Clique na marca de verificação para salvar o registro.

2. Configurar um endpoint

Para configurar um endpoint para acessar a fonte de dados de um aplicativo, siga estas etapas:

1. Selecione IDE > REST APIs.

2. Clique no botão Gerenciar Endpoints no painel do Aplicativo.

3. Selecione o aplicativo onde deseja configurar o Endpoint. Por exemplo: Northwinds Design.

4. Clique no ícone de edição para o aplicativo.

5. Insira o valor do Endpoint no campo Endpoint. Por exemplo: northwinds.

6. Clique no botão Prosseguir, depois feche o popup.

3. Publicar um endpoint

Para publicar o endpoint criado na etapa anterior:

1. Selecione IDE > REST APIs.

2. Clique no ícone Doc para a API para visualizar as informações necessárias posteriormente para se conectar a este Endpoint.

3. Clique em + Recurso no painel Recursos. O popup de Recurso se abre.

4. Selecione uma Tabela para definir um valor para o Endpoint.

5. Clique em Salvar, depois feche o popup.

6. No painel Recursos, clique no ícone Estrutura para controlar quais campos estão disponíveis na API.

   • Desmarque Incluir Por Padrão e/ou exclua campo(s) completamente para limitar o acesso via conexão API, depois feche o popup.

7. No painel Recursos, clique no ícone Abrir Registro para expandir e visualizar o popup de Recurso.

   1. O Nome do recurso deve ser anexado à URL Base e ao Endpoint do Documento da API para recuperar essas informações.

   2. Defina Limite Padrão de Obtenção ou Limite Máximo de Obtenção. Esses valores controlam a quantidade de registros retornados em chamadas GET para seu endpoint API.

   3. (Opcional, desde o App Builder 4.51.) Abra o menu Compatibilidade, depois selecione uma das seguintes opções:

      • Versão 1: Use o comportamento REST original—eventos Inserir não são precedidos por eventos Novo. (Padrão para endpoints criados com o App Builder 4.50 e anteriores.)

      • Versão 2: Use um comportamento REST aprimorado—eventos Novo e quaisquer regras padrão são invocadas antes dos eventos Inserir. (Padrão para endpoints criados com o App Builder 4.51.)

      • Versão 3: (Desde o App Builder 4.52.) Igual à versão 2, mas as APIs retornam o valor lógico em vez do valor de armazenamento. Por exemplo, valores booleanos são retornados como true ou false em vez de 1 ou 0. (Padrão para endpoints criados com o App Builder 4.52 e versões posteriores.)

   4. Feche o popup de Recurso.

4. Configurar chaves de API para usuários

Para configurar chaves de API para usuários específicos:

1. Navegue até IDE > Gerenciamento de Usuários.

2. Selecione um usuário existente ou crie um novo usuário para usar na chamada da API.

   • O usuário deve ser configurado com o Tipo de Login Interativo.

   • O usuário não precisa ter Autenticação Local.

3. No registro do usuário selecionado/criado, clique no ícone Chaves.

4. Clique em Criar e selecione a Chave de API criada no primeiro passo como o Provedor.

5. Clique em Salvar.

6. A chave gerada é o que o usuário usará para acessar a API publicada.

Para testar ou configurar o uso de seus novos endpoints de API, use a Chave de API do passo anterior, as informações de URL Base e Endpoint do documento da API, e o Nome dos detalhes do recurso.