API Gateway
Last updated
Last updated
Um API Gateway é uma ferramenta de gerenciamento de APIs, que permite criar ou utilizar APIs de terceiros num só lugar, sendo assim uma solução rápida e prática de gerenciamento de APIs. Ela atua como um proxy reverso para aceitar todas as chamadas das APIs, agregar os vários serviços necessários para executá-las, e retornar o resultado apropriado.
Com isto em mente, para facilitar a criação de seus fluxos em diferentes integrações, a solução de API Gateway da plataforma foi criado para ser a sua central de gerenciamento de APIs, possuindo autenticação Basic (com usuário e senha) para um ou mais usuários e roteamento (criação de rotas). Além disso, você pode não só gerenciar APIs externas, como criar uma API do zero, para que você possa usá-la dentro de um fluxo na plataforma.
Você pode criar um ou mais API Gateways para controlar diferentes APIs, sejam elas externas ou criadas dentro da plataforma. Para isso, siga os seguintes passos:
Na aba API Gateway, clique em "Criar API Gateway":
No modal, insira o Nome do API Gateway, Descrição (Opcional), escolha um Grupo (por padrão, é o "default") e Imagem (Opcional).
Para finalizar, clique em "Criar".
Para editar o API Gateway, basta clicar em cima do item desejado. Em seguida você será direcionado para a tela de edição. Separamos os passos para edição conforme cada item:
Para editar o "Nome" e a "Descrição", basta um clique para que a área torne-se editável.
Após as alterações, clique fora da área de edição ou pressione a tecla Enter para salvar as alterações.
Para alterar a imagem, aproxime o mouse e clique em "Editar".
Após a alteração, clique em "Salvar".
Para copiar um API Gateway, basta clicar em "Copiar URL".
Para excluir um API Gateway, basta clicar em "Excluir", localizado nos três pontinhos da área de edição do API Gateway.
Digite o nome para confirmar a exclusão e clique em "Excluir" para finalizar a ação.
Com esta funcionalidade, é possível criar diferentes versões para uma mesma API, que podem conter diferentes rotas e permissões de acesso.
Para criar uma versão:
Em "API Gateway", clique no item desejado.
Clique em "Nova versão".
Informe o Nome da versão do API Gateway e clique em "Próximo Passo".
Crie uma nova rota (mais informações abaixo) e clicar em "Salvar alterações".
Para editar uma versão:
Em API Gateway, clique no item desejado.
Em "Versões", escolha a versão que deseja modificar e clique em "Editar".
Para finalizar, clique em "Salvar alterações".
Para excluir uma versão:
Em "API Gateway", clique no item desejado.
Em "Versões", escolha a versão que deseja apagar e clique em "Excluir".
No modal, digite o nome para confirmar a exclusão e clique em "Excluir" para finalizar a ação.
Agora que você já criou ao menos uma versão, poderá criar uma ou mais rotas para a sua API.
Uma rota é um endereço (URL) que leva a um fluxo, ou seja, é um endpoint de acesso a sua API na plataforma. Com ela, você pode criar, por exemplo, uma rota de nome “/produtos “ para ser usada em todos os fluxos que mexem com produtos (salvar, listar, excluir produtos), utilizando-se de uma ou mais versões. Usando as rotas com os diferentes métodos HTTP, o API Gateway do Skyone Data facilita o uso de APIs ou a criação de APIs para a realização de certos tipos de atividades em diferentes fluxos.
Para uma maior flexibilidade, o nosso API Gateway permite a criação de dois tipos de rotas: Trigger e HTTP, que veremos em detalhes a seguir.
Quando você cria uma rota HTTP, que sempre utiliza uma API externa, você pode apontar para uma rota em um dado idioma, mesmo que o endpoint esteja em um idioma diferente, facilitando o uso de APIs externas por qualquer usuário do Skyone Data. Logo se, por exemplo, você quiser fazer uma requisição ao endpoint “/orders/approve” de uma API, poderá criar uma rota denominada “/pedidos/aprovar”.
Ou seja, em vez de utilizar a API externa, sem customização, você a utiliza com uma URL única e com dados personalizados: rota, versão e acesso por usuário (autenticação Basic).
Com a versão já criada, ao clicar em "Próximos passos", você será direcionado para criar a rota.
Clique em "Criar nova rota".
Informe os dados da rota, sendo que:
Informe a URL da Rota que você deseja utilizar na rota, que pode ser diferente do original.
Escolha um ou mais Métodos de rota do API Gateway (GET, POST, PUT, PATCH OU DELETE);
Em Tipo da Rota, escolha HTTP;
Informe o Protocolo (HTTP ou HTTPS), o Host (endereço da API) e a Porta utilizada;
Informe o Path (caminho) original da API (endpoint)
Escolha o Limite de execuções (número de execuções e o período);
Opcionalmente, caso já tenha criado um usuário, clique na opção "Rota protegida" e escolha o usuário que precisa ter acesso a esta rota;
4. Para finalizar a ação, clique em "Salvar rota".
Com a versão já criada, ao clicar em "Próximos passos", você será direcionado para criar a rota.
Clique em "Criar nova rota".
Quando você cria uma rota Trigger, que não utiliza uma API externa, você pode realizar diferentes operações, sem ter que repetir a configuração em cada fluxo, além de controlar o acesso conforme o usuário cadastrado no API Gateway, caso deseje que o acesso seja restrito.
Ou seja, em vez de repetir os dados em diferentes fluxos, você a utiliza com uma URL única e com dados personalizados: rota, versão e acesso por usuário (autenticação Basic).
Com a versão já criada, ao clicar em "Próximos passos", você será direcionado para criar a rota.
Clique em "Criar nova rota".
Informe os dados da rota, sendo que:
Informe a URL da Rota que você deseja utilizar na rota, que pode ser diferente do original;
Escolha um ou mais Métodos de rota do API Gateway (GET, POST, PUT, PATCH OU DELETE);
Em Tipo da Rota, escolha Trigger;
Escolha o Limite de execuções (número de execuções e o período);
Opcionalmente, caso já tenha criado um usuário, clique na opção Rota protegida e escolha o usuário que precisa ter acesso a esta rota;
Para finalizar a ação, clique em "Salvar rota".
Para editar, a qualquer momento, uma rota criada:
Dentro da versão do seu API Gateway, escolha o item que deseja alterar e clique em "Editar":
Depois de fazer as alterações, clique em "Salvar alterações".
É possível gerenciar a quantidade de execuções da sua API Gateway através do Limite de Execuções, ou seja, determinar o máximo de vezes em que o API será requisitado durante um período de tempo.
Para isso, na edição de uma rota, escolha o número e a medida de tempo (segundo, minuto ou hora) desejados.
Para finalizar, clique em "Salvar Alterações".
A medida de tempo é contabilizada por segundo, minuto e hora padrão cheia. Por exemplo: Imagine que você tem uma rota e o limite de execuções está configurado para 2 por minuto. Mesmo que a chamada comece às 08:45:55, o limite é até 08:45:59, pois às 08:46:00 será contabilizada como uma nova série de execuções.
Para editar, a qualquer momento, uma rota criada:
Dentro da versão do seu API Gateway, escolha o item que deseja alterar e clique em "Excluir":
No modal, digite o nome para confirmar a exclusão e clique em "Excluir" para finalizar a ação.
Caso queira restringir o acesso a um ou mais usuários, você poderá fazer isso, utilizando-se de uma autenticação (Básico ou oAuth2).
Para criar um usuário, em API Gateway, clique na aba "Usuários":
Clique em "Adicionar usuário";
Personalize o restante do nome de Usuário;
Escolha o tipo de autenticação: Básico ou oAuth2 e siga a configuração de acordo com o tipo:
Para finalizar a configuração do usuário do tipo Basic, informe a Senha, e depois clique em "Salvar usuário".
Os usuários criados são listados na guia "Usuários" do API Gateway.
Para editar um usuário:
Em API Gateway, na aba Usuários, clique no ícone de "Editar" do usuário desejado.
Faça as alterações necessárias (usuário ou senha) e clique em "Salvar usuário".
Para excluir um usuário:
Em API Gateway, na aba Usuários, clique em "Excluir" do usuário desejado.
No modal, digite o nome para confirmar a exclusão e clique em "Excluir" para finalizar a ação.
Você pode excluir qualquer usuário, desde que ele não esteja atualmente associado a uma rota. Se este for o caso, você precisa editar as rotas que incluem o usuário e removê-lo da caixa de combinação "Esta rota é protegida?".
Leia também:
