> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/api-gateway/criando-seu-primeiro-metodo.md).

# Criando seu primeiro método

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.

<figure><img src="/files/AZU9AkQqNcpwuyloOC6j" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/Sa4mulzrXKSa4BJ1GeaU" alt=""><figcaption><p>Modal de criação de Método</p></figcaption></figure>

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:

<figure><img src="/files/2cNGqp7LyRvxedihsAje" alt=""><figcaption><p>Método criado</p></figcaption></figure>

{% hint style="success" %}
Sucesso!! Você criou o seu primeiro método!
{% endhint %}

## Segurança

### Configurando segurança dentro do Método

Você pode selecionar quais meios de segurança terá o seu método específico.

<figure><img src="/files/iA4gT8ZmtN6SojnF73VF" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/DthVKf9B7DjWahR4wro9" alt=""><figcaption></figcaption></figure>

#### - Acesso público

<figure><img src="/files/mgPJR6jVuugxvJqXG4nd" alt=""><figcaption></figcaption></figure>

#### - Restringir IPs

Quando selecionado, abrirá um campo para que você insira quais IPS poderão ter acesso ao método.

<figure><img src="/files/ksq1MSLOocJ9gUYxB6Kw" alt=""><figcaption></figcaption></figure>

#### - Restringir clientes

Quando selecionado, abrirá um campo para que você insira quais clientes poderão ter acesso ao método.

<figure><img src="/files/vEHW9PQyJOH4iQ1joevG" alt=""><figcaption></figcaption></figure>

#### - **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 `************`.

#### <sub>Modos de correspondência</sub>

* **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`.

#### <sub>Parâmetros para API Gateway</sub>

* **Caminho final:** só o nome da chave (ex.: `password`, `token`, `apiKey`).
* **Caminho completo:** notação por pontos (ex.: `flow.password`, `request.token`).

#### <sub>Boas práticas</sub>

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

<figure><img src="/files/rDf1pLYk228q8rge7JxS" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/Bf8HQO2kTPWjCdwmp9OK" alt=""><figcaption><p>Após clicar na opção, você terá acesso a um modal de criação de Cliente</p></figcaption></figure>

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

<figure><img src="/files/zBeRrJO48RI6OCQhefcx" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
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.
{% endhint %}

### Utilizando cliente na requisição

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

<figure><img src="/files/2KoolFzwsc3StbyMXX05" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/7hy7ykTlIzwLBf18ax0s" alt=""><figcaption></figcaption></figure>

3. No Headers na sua requisição crie o campo chamado **"client\_id",** e insira o valor do ID do Cliente:

<figure><img src="/files/PNQNq55IX3s0LRo24ZEN" alt=""><figcaption><p>Exemplo utilizando Postman</p></figcaption></figure>

{% hint style="success" %}
Sucesso!! Você consumiu sua primeira API com segurança!!
{% endhint %}