Autenticação

A seção Auth é onde você faz a configuração da autenticação. Normalmente, a maioria dos serviços de API exige autenticação para evitar solicitações não autorizadas.

2026-08-11

O sistema Mini-App V2 suporta 2 tipos de autenticações, Api Key e OAuth v2.

Chave API

Escolha Chave API no tipo de autenticação e clique em Editar e em Adicionar itens para adicionar entradas de autenticação.

Parâmetros
Descrição
Nome único
Único em todas as entradas de autenticação, não é possível inserir um espaço. Use sublinhados ou hífens para separar palavras
Tipo
Escolha String para texto sem retornos de carro, Número para números inteiros ou flutuantes, Texto para texto com retornos de carro, Selecione para entrada de origem estática ou dinâmica
Título
O título é exibido na interface do usuário
Obrigatório?
Esta entrada é obrigatória? caso contrário, desligue e forneça um valor padrão, se necessário
Salvar no campo do aplicativo
Especifique onde armazenar o valor. Crie um novo campo de aplicativo aqui mesmo, digitando um novo nome de campo e selecionando um tipo de campo no pop-up ou pesquise um campo existente
Espaço reservado
O prompt cinza é exibido na caixa de entrada
Descrição
O prompt preto é exibido abaixo da caixa de entrada

Adicione quantas entradas de autenticação forem necessárias e clique em Salvar quando terminar.

OAuth V2

Escolha OAuth v2 em Auth Type e configure as 3 etapas mostradas abaixo.

Nota
DICA – Veja como configurar o OAuth v2 em uma demonstração do aplicativo Google Agenda.

Solicitação de autenticação

Se você precisar enviar as entradas de autenticação para obter mais informações, use Auth Request.

Por exemplo, alguns provedores de serviços terceirizados exigem que os usuários forneçam seus usernamee password. E com esses 2 valores geram um token para comunicação posterior em algumas horas.

Nesse caso, você pode coletar usernamee passwordnas entradas de autenticação e enviar a solicitação de token em Auth Request.

Configure a solicitação externa e clique em Testar, você verá os dados necessários na área de resposta. Selecione o token e mapeie-o de volta ao aplicativo clicando no botão Adicionar. Clique em Salvar para salvar sua solicitação de autenticação: