Criando seu primeiro método
Neste módulo você poderá criar métodos que serão expostos para serem consumidos como uma API. Este método irá ativar um fluxo existente no Hyperflow.
Criando seu primeiro Método
No menu, selecione a opção "API Gateway", e clique no botão com o símbolo "+", onde abrirá um modal para criação do método.
Com o modal aberto, selecione qual será o tipo do método que deseja em sua API, como POST, GET, PUT, PATCH e DELETE. Também é necessário definir a rota da sua API e qual será o FLUXO a ser ativado quando a API for consumida.
Clique em "Confirmar".
Para conferir a atual estrutura do seu novo método, selecione a rota que você criou, e dentro da rota selecione o método, como demonstra na imagem abaixo:
Sucesso!! Você criou o seu primeiro método!
Segurança
Configurando segurança dentro do Método
Você pode selecionar quais meios de segurança terá o seu método específico.
Com o método selecionado, há três opções de segurança que você pode selecionar para a sua API. Tais opções são: "Acesso público", "Restringir IPs" e "Restringir clientes".
Estes mesmos métodos de segurança podem ser ativados para funcionar em todas as suas rotas, basta acessar a aba "Segurança", que estas mesmas opções se encontrarão lá.
- Acesso público
- Restringir IPs
Quando selecionado, abrirá um campo para que você insira quais IPS poderão ter acesso ao método.
- Restringir clientes
Quando selecionado, abrirá um campo para que você insira quais clientes poderão ter acesso ao método.
Criando clientes
Você pode criar clientes para especificar o nível de segurança de sua rota, estes clientes você passará no Header da sua requisição.
Para criar um cliente, acesse a Aba "Clientes" e clique na opção "Adicionar cliente".
No modal de adição de Cliente,o único campo obrigatório é o campo "Nome", portanto, digite o nome do cliente e clique em "Confirmar".
Sucesso!! Você criou o seu primeiro cliente, agora você pode ter mais segurança em suas rotas, basta ativar a opção de segurança "Restringir clientes" e selecionar o cliente criado.
Utilizando cliente na requisição
Ativa a opção se segurança "Restringir clientes", e seleciona o seu cliente.
Pegue o Endpoint da sua organização e o valor do seu Cliente:
No Headers na sua requisição crie o campo chamado "client_id", e insira o valor do ID do Cliente:
Sucesso!! Você consumiu sua primeira API com segurança!!
Last updated