Publicar Aplicativo Vinyl Como Endpoint da API REST¶

Visão Geral¶

No Vinyl você pode configurar um servidor Vinyl para ser uma API para que os dados da aplicação possam ser acessados através de uma chave API. Este recurso permite criar uma chave de API e Endpoints em aplicativos. Este guia mostrará um exemplo usando dados Northwinds e utiliza uma chave de API para conectar-se a um Endpoint criado em um aplicativo selecionado.

Como Publicar o Aplicativo Vinyl 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 de usuário no painel Autenticação de usuário
3. Atribua um Nome ao provedor. Por exemplo: Chave API
4. Selecione Chave de API como o valor de 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ê deseja digitar a API na barra de localização do navegador para teste (não muito seguro), então
   1. Clique em + Propriedade no painel Propriedades
   2. Selecione AllowApiKeyInQueryString como o parâmetro
   3. Insira True como o valor
   4. Clique na marca de seleção para salvar o registro
2. Se você estiver usando HTTP, configuração não recomendada, será necessário 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 a aplicação onde deseja configurar o Endpoint. Por exemplo: Projeto Northwinds
4. Clique no ícone de edição lápis do aplicativo
5. Insira o valor do Endpoint no campo Endpoint. Por exemplo: Ventos Norte
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á posteriormente para se conectar a este Endpoint
3. Clique em + Business Object no painel Business Objects e selecione uma Tabela para definir um valor para o Endpoint. Por exemplo: Categoria (Fonte)
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 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 ao URL base e ao Endpoint do documento da API para recuperar essas informações
7. Clique em Editar para definir Default Get Limit ou Get Max Limit. Esses valores controlam a quantidade de registros retornados em chamadas GET para seu endpoint de API

Por último, 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 estar 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 o Provedor
5. Clique em Salvar
6. A Chave gerada é a que o Usuário utilizará para acessar a API publicada

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

Para testar ou configurar o uso de 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.