Una clave de API permite que un desarrollador, o una herramienta que tú uses, utilice la Open API de Mateflow para leer y escribir los datos de tu comunidad. Creas y revocas las claves de API en Admin → Configuración → Integraciones → Acceso a la API. Cada clave funciona solo para una comunidad.
Quién puede hacerlo: los propietarios y administradores. · Dónde: web (consola de administración). · Plan: el acceso a la API, y cuántas solicitudes a la API al día puede hacer tu comunidad, dependen de tu plan de la plataforma.
Las claves de API son por comunidad
Las claves de API pertenecen a una sola comunidad, y las solicitudes hechas con una clave siempre actúan sobre esa comunidad. Para conectar varias comunidades, crea una clave en la consola de administración de cada una.
El panel de creador (app.mateflow.com) no tiene claves de API. Las claves del espacio de trabajo que había allí se han sustituido por claves por comunidad. La página Resumen de una comunidad en el panel enlaza a su página Integraciones.
Crear una clave de API
- Ve a Admin → Configuración → Integraciones y abre la pestaña Acceso a la API.
- Haz clic en Generar nueva clave.
- Escribe un Nombre de la clave que indique para qué sirve, como la herramienta que la usará.
- En Ámbitos y permisos, marca solo los permisos que necesita la integración. Consulta la siguiente sección.
- Opcional: en Lista blanca de IP (opcional), escribe las direcciones o rangos de IP que pueden usar la clave, separados por comas.
- Haz clic en Generar nueva clave.
- Copia la clave desde Clave de API generada, guárdala en un lugar seguro y haz clic en Listo.
Solo puedes ver la clave completa una vez. Si la pierdes, genera una clave nueva y revoca la anterior.
Si la pestaña Acceso a la API muestra un aviso para mejorar el plan, tu plan de la plataforma no incluye el acceso a la API. La tarjeta Endpoint de la API muestra la URL base de las solicitudes y el límite diario de solicitudes de tu plan, que se restablece a las 00:00 UTC.
Ámbitos (permisos) de las claves de API
| Ámbito | Qué permite |
|---|---|
| Leer comunidad | Leer el perfil, la configuración y los metadatos de la comunidad |
| Leer contenido | Leer publicaciones, feeds, respuestas y resultados de búsqueda |
| Escribir contenido | Crear, editar y eliminar publicaciones y respuestas |
| Subir medios | Solicitar tokens de subida; también permite leer las URL firmadas de los archivos multimedia |
| Leer medios | Leer las URL firmadas de los archivos multimedia existentes |
| Leer espacios | Listar los espacios y leer sus detalles |
| Leer miembros | Buscar miembros y leer sus perfiles básicos, incluidos sus grupos de acceso |
| Invitar miembros | Invitar a personas por correo electrónico o con un enlace de invitación |
Leer miembros e Invitar miembros aparecen en Acceso sensible. Leer miembros permite a la integración comprobar si una dirección de correo electrónico pertenece a tu comunidad. Con Invitar miembros, las invitaciones se envían en nombre del propietario de la comunidad salvo que la integración indique otro remitente, y las personas invitadas siempre se unen como miembros. Las invitaciones por API pueden incluir grupos de acceso. Consulta Cómo funcionan los grupos de acceso.
Los ámbitos de una clave no se pueden cambiar después. Las claves más antiguas pueden mostrar Todos (heredado): conservan solo los ámbitos que existían cuando se crearon. Crea una clave nueva para usar ámbitos más recientes.
Revocar una clave de API
- En la pestaña Acceso a la API, busca la clave en Claves de API.
- Abre su menú de acciones y haz clic en Revocar clave.
- Confirma. La revocación no se puede deshacer, y cualquier herramienta que use la clave deja de funcionar.
La lista muestra el Estado de cada clave (Activa, Expirada o Revocada) y la fecha de Último uso. Las solicitudes a la API no aparecen en Registros de entrega, así que Último uso es la forma de comprobar si una clave se sigue usando. Desconectar Slack, Discord o Zapier no revoca ninguna clave de API.
Mantener seguras las claves de API
- Guarda las claves de API en un servidor, no en un sitio web ni en una app que otros puedan descargar, y envía las solicitudes por HTTPS.
- Da a cada herramienta su propia clave con solo los ámbitos que necesita, para poder revocar una sin romper las demás.
- Añade una Lista blanca de IP cuando la herramienta llame desde direcciones fijas.
- Revoca una clave de inmediato si puede haberse filtrado y después crea una de reemplazo.
Dónde encontrar la documentación de la API
La referencia de la API describe los endpoints, los formatos de solicitud y respuesta, los ámbitos, los códigos de error y ejemplos de código. En la pestaña Acceso a la API, la tarjeta Documentación para desarrolladores tiene un botón Abrir documentación que lleva a mateflow.com/developers. Envía ese enlace a tu desarrollador. No necesita una cuenta en tu comunidad, y la página está disponible aunque tu plan no incluya el acceso a la API.
Artículos relacionados
¿Te resultó útil esta guía?