Hyperflow
Studio
  • 👋Bem-vindo(a) ao Help Hyperflow!
  • Sobre a Hyperflow
    • 💡O que fazemos?
    • ✨Nossos recursos
    • 🙌Comunidade Hyperflow
  • Primeiros passos
    • ✏️Criando sua conta
    • 🔐Acessando a plataforma
    • ▶️Verificando o BM Meta
    • 🤖Criando o primeiro fluxo
  • Canais de atendimento
    • 🟢WhatsApp
      • 🤖Como conectar seu bot Hyperflow no WhatsApp
      • 🧵Passo a passo: criação de conta no WhatsApp Business API
      • 💬O que você precisa saber sobre conversas do WhatsApp Business API
      • 🛑Limites de mensagem: regras e boas práticas do WhatsApp Business API
      • 🧪Número de teste para WhatsApp
      • 📰Utilizando catálogo no WhatsApp
      • 📈Otimizar mensagens de marketing
    • 💟Instagram
      • 🤖Como conectar seu bot Hyperflow no Instagram
      • Vinculado o chatbot ao Instagram
    • 🔵Telegram
      • Conectando o Telegram
    • 🗃️WebSDK
      • Como conectar seu bot no WebSDK
      • Configurações da WebSDK
      • Como incluir o WebSDK em um aplicativo
    • ☑️Facebook Messenger
    • 📳SMS
  • Builder de chatbots
    • 🎲Conheça os Módulos
    • ℹ️Ação
      • 📤Executar código (run code)
      • ⏳Iniciar Inatividade (start inactivity)
      • ⌛Finalizar Inatividade (end inactivity)
      • ⛳Tag de usuário (user tag)
      • 🍃Variável de fluxo (flow variable)
      • 🙋Variável de usuário (user variable)
      • ⏸️Esperar
      • ⏰Enviar alerta (send alert)
    • 🛎️Atendimento
      • ✨Iniciar/atualizar atendimento (Init/Update attendance)
      • 🗃️Adicionar uma classificação no atendimento (Classification attendance)
      • 📟Adicionar um rótulo no atendimento
      • 🔚Encerrar atendimento (Finish attendance)
      • ⏱️Tamanho da fila (Queue size)
      • 🟢Agente online (online agent)
      • 🧑Transferir para atendente (Transfer human)
    • 🎮Controle de fluxo
      • 🔢Condicional (conditional)
      • 🛑Fim do fluxo (end flow)
      • ⏲️Intervalo de tempo (time interval)
      • 🐇Pular para fluxo (jump)
      • 🧪Teste A/B (split A/B)
    • ⚡Gatilho
      • Referência de mensagem (Ads)
      • Agendamento
      • Ativar usuário
      • Intenção
    • 💎Integração
      • AWS - Dynamo DB
      • AWS - S3
      • AWS - Secrets Manager
      • AWS - SES
      • AWS - SQS
      • Consulta em banco de dados
      • Enviar e-mail
      • Firebird
      • Google Analytics
      • Google Calendars
      • Google Sheets
      • HTML to PDF
      • JWT
      • Oracle DB
      • Requisição GraphQL
      • Requisição REST
      • Requisição SOAP
      • Send Grid
      • XML to JSON
    • 🎧Resposta
      • Enviar mensagem
      • JSON
  • Builder Hyperflow
    • 📄Gerenciamento de conta
      • 🏠Início
      • 🚀Aplicativos
      • 👥Membros
      • 💳Métodos de pagamento
      • 💵Gerenciar créditos Meta
      • 💰Faturas
      • 🗃️Dados cadastrais
    • 🤖Gerenciamento de bots e integrações
      • 🏡Início aplicativos
      • 🪄Fluxos
      • 💬Canais
      • 📣Transmissões
      • ⛓️Integrações
        • ✴️Hubspot App
          • 🔵Ação 1 - Iniciar Fluxo
          • 🟡Ação 2 - Iniciar Atendimento
          • 🔴Ação 3 - Verificar propriedade de um fluxo
      • 👾Variáveis de ambiente
      • 🧠Processamento de Linguagem Natural (NLP)
        • 💬Conectando o Dialogflow
      • 👩‍💻Atendimento
      • ☁️API Gateway
        • Criando seu primeiro método
      • 📈Tempo real
      • 👤Contatos
      • 🏬Faturas
      • ⚙️Configurações
  • Desk Hyperflow
    • 🔔Visão geral de atendimento
      • Início
      • Dashboard
      • Atendimentos
      • Histórico de Chats
      • Figurinhas
      • Rótulos
    • 👩‍💻Gerenciamento de atendimento e time
      • Classificações
      • Contatos
      • Agentes
      • Departamentos
      • Times
    • 🛠️Relatórios, mensagens e configurações
      • Relatórios
      • Atalhos
      • HSMs
      • Configurações
        • Parâmetros
        • Usuários
  • Guias
    • ⛑️Boas práticas para desenvolvimento de bots na Hyperflow
    • 🏦Domínios e IPs Hyperflow
    • 🤖Criando um Bot
    • 📱Enviar um ativo baseado em uma planilha do Google Sheets
  • 💚5 boas práticas para evitar bloqueio e suspensão de conta no WhatsApp Business API
  • 💡Assistente GPT
  • ⚡Executar automação durante atendimento humano (Gatilhos)
  • 🔎Criar Pesquisa de Satisfação
  • 🔒Autenticação de 2 fatores (Segurança)
  • 🔔Novidades (Release notes)
    • Release 15/05/25
    • Release 29/04/25
    • Release 16/04/25
    • Release 20/03/25
    • Release 23/02/25
    • Release 30/01/25
    • Release 13/12/24
    • Release 20/11/24
    • Release 25/10/24
    • Release 07/10/24
    • Release 25/09/24
    • Release 22/09/24
    • Release 04/09/24
    • Release 17/07/24
    • Release 28/06/24
    • Release 10/06/24
    • Release 03/06/24
    • Release 30/04/24
    • Release 15/04/24
    • Release 02/04/24
    • Release 19/03/24
    • Release 05/03/24
    • Release 20/02/24
    • Release 06/02/24
    • Release 23/01/24
    • Release 03/01/24
    • Release 19/12/23
    • Release 28/11/23
    • Release 06/11/23
    • Release 11/10/23
    • Release 12/06/23
    • Release 29/05/23
    • Release 14/05/23
  • FAQ
    • ❓FAQ - Hyperflow
      • 🚀A Plataforma
      • ✅WhatsApp Business API
      • 👩‍💻Atendimento
      • ⚡Integrações
      • ☁️iPaaS
      • 💬CPaaS
Powered by GitBook
On this page
  • Segurança
  • Configurando segurança dentro do Método
  • Criando clientes
  • Utilizando cliente na requisição

Was this helpful?

  1. Builder Hyperflow
  2. Gerenciamento de bots e integrações
  3. API Gateway

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.

PreviousAPI GatewayNextTempo real

Last updated 1 year ago

Was this helpful?

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

  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:

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

🤖
☁️
Modal de criação de Método
Método criado
Após clicar na opção, você terá acesso a um modal de criação de Cliente
Exemplo utilizando Postman