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".

Modal de criação de Método

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:

Método criado

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.

- Ofuscar dados confidenciais

• Função: Mascarar dados sensíveis nos logs, garantindo privacidade e evitando exposição.

• Persistência: Valores ofuscados são armazenados no banco já mascarados; mesmo desativando depois, registros antigos seguem como ************.

_{Modos de correspondência}

• Caminho final: Oculta qualquer chave com o mesmo último nome. Ex.: "password" → flow.password, request.body.password, response.password.

• Caminho completo: Oculta apenas o caminho exato informado. Ex.: "request.body.password" não oculta flow.password.

_{Parâmetros para API Gateway}

• Caminho final: só o nome da chave (ex.: password, token, apiKey).

• Caminho completo: notação por pontos (ex.: flow.password, request.token).

_{Boas práticas}

• Use Caminho final para chaves comuns.

• Use Caminho completo para granularidade maior (ex.: request.headers.authorization).

⚡ Os valores ofuscados se aplicam apenas aos logs da requisição no API Gateway.

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".

Após clicar na opção, você terá acesso a um modal de criação de 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

1. Ativa a opção se segurança "Restringir clientes", e seleciona o seu cliente.

1. Pegue o Endpoint da sua organização e o valor do seu Cliente:

1. No Headers na sua requisição crie o campo chamado "client_id", e insira o valor do ID do Cliente:

Exemplo utilizando Postman

Sucesso!! Você consumiu sua primeira API com segurança!!