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

Visão Geral

No App Builder, você pode configurar um servidor App Builder para ser uma API, de modo que os dados do aplicativo possam ser acessados por meio de uma Chave de API. Esse recurso permite que você crie 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 o aplicativo App Builder como um endpoint de API REST

Primeiro, você precisará configurar uma Chave de API do Provedor de Segurança para fornecer autenticação para acessar os Endpoints:

1. Navegue até IDE > Provedores de Segurança
2. Clique em + Autenticação de Usuário no painel de 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ê quiser 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 de Propriedades
   2. Selecione AllowApiKeyInQueryString como o Parâmetro
   3. Digite True como o Valor
   4. Clique no checkmark para salvar o registro
2. Se você estiver usando HTTP, configuração não recomendada, então você precisa adicionar o seguinte:
   1. Clique em Criar
   2. Selecione AllowInsecureHttp como o Parâmetro
   3. Digite True para o Valor
   4. Clique no checkmark para salvar o registro

Em seguida, você precisará configurar um Endpoint para acessar a fonte de dados de um aplicativo:

1. Navegue até IDE > REST APIs
2. Clique no botão Gerenciar Endpoints no painel do Aplicativo
3. Selecione o aplicativo onde você deseja configurar o Endpoint. Por exemplo: Design do Northwinds
4. Clique no ícone de edição lápis para o aplicativo
5. Digite o valor do Endpoint no campo Endpoint. Por exemplo: Northwinds
6. Clique no botão Prosseguir

Agora você publicará o Endpoint que criou na etapa anterior:

1. Navegue até IDE > REST APIs
2. Clique no ícone Doc para a API para visualizar as informações que você precisará mais tarde para se conectar a este Endpoint
3. Clique em + Objeto de Negócio no painel de Objetos de Negócio e selecione uma Tabela para definir um valor para o Endpoint. Por exemplo: Categoria (Fonte)
4. Clique no ícone marca de verificação para salvar o registro
5. Clique no ícone Estrutura para controlar quais campos estão disponíveis na API
   1. Desmarque Incluir Por Padrão e/ou exclua campo(s) completamente para limitar o acesso via conexão API
6. No painel de Tabelas, clique no ícone Abrir Registro para expandir e visualizar o pop-up de Detalhes do Recurso
   1. O Nome do recurso precisará ser anexado à URL Base e ao Endpoint do Documento da API para recuperar essas informações
7. Clique em Editar para definir 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
8. (Opcional, desde o App Builder 4.51.) Abra o menu Compatibilidade, em seguida, 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 e posteriores.)

Por fim, você 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
   1. O Usuário deve ser configurado com o Tipo de Login Interativo
   2. 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 na primeira etapa como o Provedor
5. Clique em Salvar
6. A Chave gerada é o que o Usuário usará para acessar a API publicada

Opcionalmente, você pode configurar funções/grupos de segurança para o(s) Objeto(s) que estão sendo acessados como Endpoints.

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