TABLA DE CONTENIDOS
- Cómo recibir una clave de aplicación
- Cómo Manychat maneja las solicitudes no autorizadas
- Cómo añadir ámbitos
- Periodo de transición
Algunas aplicaciones requieren acceso a la API pública de Manychat.
Generalmente, la clave de API demuestra que la llamada de API es legítima, pero para desarrolladores de aplicaciones y usuarios de la aplicación, decidimos hacer más transparente el proceso de exposición del acceso a la API.
Manychat genera una clave de aplicación única para cada instalación de la aplicación: demuestra que tu aplicación ha obtenido el permiso para llamar a las API seleccionadas para este bot.
Aquí hay tres pasos sobre cómo obtener una clave de aplicación con un ámbito previamente configurado.
- Al crear una aplicación, puedes especificar los endpoint a los que necesitas acceso:
- Los usuarios de tu aplicación serán notificados durante el proceso de instalación como se muestra a continuación:
- Tan pronto como la aplicación esté instalada, Manychat genera la clave de aplicación
Cómo recibir una clave de aplicación
- Configura el endpoint en tu sitio web para recibir una solicitud después de que tu aplicación esté instalada. A continuación, añade un objeto de solicitud en App JSON, sección de autenticación:
"request": { "url": "your endpoint is here", "method": "POST", "headers": [ "Content-Type: application/json", "x-token-header: {{app_token}}" // clave de aplicación puede ser recibida en los encabezados ], "mapping": [], "payload": { "app_token": "{{app_token}}" // clave de aplicación puede ser recibida en la carga útil } }
También puedes utilizar variables de sistema como {{app_id}}, {{app_version}}, {{page_id}} y personalizadas que los usuarios de la aplicación especifican en la sección auth.params.
Cuando se recibe el código de estado 200 OK, Manychat indica esto en el bloque de configuración de la aplicación
De lo contrario, indicamos un error y pedimos a los usuarios que vuelvan a intentar:
- Captura la clave de aplicación manualmente. Si no hay ningún objeto de solicitud en la sección auth, generamos la clave de aplicación y dejamos que los usuarios la copien y peguen en la interfaz de usuario de tu sitio web:
Si vas a listar tu aplicación en nuestra App Store, te recomendamos encarecidamente que implementes la obtención de la clave de aplicación del sitio web del servidor.
Cómo Manychat maneja las solicitudes no autorizadas
Si tu aplicación está desinstalada, con cada llamada recibirás el código de respuesta 500
{"status": "exception","message": "Something went wrong"}
Si tu solicitud está fuera del ámbito permitido, recibirás el código de respuesta 401
{"status": "error","message": "Wrong access token"}
Cómo añadir ámbitos
Para aplicaciones públicas ya existentes, ve a la aplicación, pestaña Acceso a la API. Luego añade ámbitos, guarda tu aplicación y vuelve a publicarla. Después de pasar la revisión, los ámbitos se añadirán a tu aplicación, y la clave de aplicación se generará automáticamente para todas las instalaciones.
Para aplicaciones de desarrollo, todos los cambios se aplican inmediatamente (incluyendo la generación de la clave de aplicación).
Periodo de transición
Te recomendamos encarecidamente que utilices una clave de aplicación para todas tus aplicaciones. Obtener una clave de API a través del bloque de autenticación no es transparente y puede perjudicar la experiencia del usuario.
A partir del 1 de febrero de 2021, será obligatorio configurar el acceso a la API a través de la clave de aplicación.
Si deseas discutir tu plan de transición con el equipo de Manychat, envíanos un mensaje a devprogram@manychat.com