Publicar App Builder aplicativo Como Endpoint da API REST¶

Visão Geral¶

Em App Builder você pode configurar an App Builder servidor para ser uma API para que os dados do aplicativo possam ser acessados por meio de uma API Key. Esse recurso permite que você crie uma API Key e Endpoints em aplicativos. Este guia mostrará um exemplo usando dados do Northwinds e utiliza uma API Key para se conectar a um Endpoint criado em um aplicativo selecionado.

Como Publicar App Builder aplicativo Como Endpoint da 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 do usuário no painel Autenticação do usuário
3. Atribua ao provedor um Nome. Por exemplo: Chave de API
4. Selecione Chave API como o valor Tipo
5. Marque para selecionar Ativado
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 teste (não muito seguro), então
   1. Clique em + Propriedade no painel Propriedades
   2. Selecione AllowApiKeyInQueryString como Parâmetro
   3. Insira True como Valor
   4. Clique na marca de seleção 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. Insira True para o valor
   4. Clique na marca de seleção para salvar o registro

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

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

Em seguida, você publicará o Endpoint criado na etapa anterior:

1. Navegue até IDE > APIs REST
2. Clique no ícone Doc da API para visualizar as informações que você precisará mais tarde para se conectar a este Endpoint
3. Clique em + Business Object no painel Business Objects e selecione uma Table para definir um valor para o Endpoint. Por exemplo: Category (Source)
4. Clique no ícone marca de seleçã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 o(s) campo(s) completamente para limitar o acesso via conexão de API
6. No painel Tabelas, clique no ícone Abrir registro para expandir e visualizar o pop-up 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 de obtenção padrão ou Limite máximo de obtenção, esses valores controlam a quantidade de registros retornados em chamadas GET para seu endpoint de API

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 de 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 de usuário selecionado/criado, clique no ícone Chaves
4. Clique em Criar e selecione a Chave API criada na primeira etapa como 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 os objetos acessados como Endpoints.

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