TABELA DE CONTEÚDOS
- Como receber uma Chave de Aplicativo
- Como o Manychat lida com solicitações não autorizadas
- Como adicionar escopos
- Período de transição
Alguns aplicativos requerem acesso à API Pública do Manychat.
Geralmente, a chave de API prova que a chamada da API é legítima, mas para desenvolvedores de aplicativos e usuários de aplicativos, decidimos tornar o processo de expor o acesso à API mais transparente.
O Manychat gera uma Chave única de App para cada instalação de aplicativo, o que prova que seu aplicativo obteve a permissão para chamar as APIs selecionadas para este bot.
Aqui estão três passos para obter uma Chave de Aplicativo com um escopo pré-configurado.
- Ao criar um app, você pode especificar pontos de extremidade para os quais precisa de acesso:
- Os usuários do seu aplicativo serão notificados durante o processo de instalação, como mostrado abaixo:
- Assim que o app for instalado, o Manychat gera a a Chave de Aplicativo
Como receber uma Chave de Aplicativo
- Configure o ponto de extremidade no seu lado para receber uma requisição após a instalação do seu aplicativo. Em seguida, adicione um objeto de requisição no App JSON, seção de autenticação:
"request": { "url": "your endpoint is here", "method": "POST", "headers": [ "Content-Type: application/json", "x-token-header: {{app_token}}" // chave de app pode ser recebida nos cabeçalhos ], "mapping": [], "payload": { "app_token": "{{app_token}}" // chave de app pode ser recebida em payload } }
Também é possível usar variáveis de sistema como {{app_id}}, {{app_version}}, {{page_id}} e varáveis personalizadas que os usuários do aplicativo especificam na seção auth.params.
Quando o código de estado 200 OK é recebido, o Manychat indica isso no bloco de Configuração de Apps
Caso contrário, indicamos um erro e solicitamos que você tente novamente:
- Capture a chave de app manualmente. Se não houver objeto de requisição na seção de autenticação, nós geramos a chave de aplicativo e permitimos que os usuários a copiem e cole na interface do usuário no seu lado:
Se você vai listar seu app em nossa App Store, recomendamos fortemente a implementação da Chave de App no lado do servidor.
Como o Manychat lida com solicitações não autorizadas
Se seu aplicativo for desinstalado, com cada chamada você receberá o código de resposta 500
{"status": "exception","message": "Algo deu errado"}
Se sua solicitação estiver fora do escopo permitido, você receberá o código de resposta 401
{"status": "error","message": "Token de acesso errado"}
Como adicionar escopos
Para apps públicos já existentes, acesse o aplicativo e a aba Acesso API. Em seguida, adicione escopos, salve seu aplicativo e publique novamente. Após passar a revisão, os escopos serão adicionados ao seu aplicativo, e a chave de aplicativo será gerada automaticamente para todas as instalações.
Para apps em desenvolvimento, todas as alterações se aplicam imediatamente (incluindo a geração da Chave de App).
Período de transição
Recomendamos fortemente que você use uma Chave de Aplicativo para todos os seus aplicativos. Obter uma chave de API através do bloco de autenticação não é transparente e pode prejudicar a experiência do usuário.
Configurar o acesso da API através da Chave de App será obrigatório a partir do dia 1 de fevereiro de 2021.
Se você quiser discutir seu plano de transição com a equipe do Manychat, por favor envie-nos uma mensagem para devprogram@manychat.com