Desarrolladores
Construye sobrela API de Mateflow.
Una clave, una comunidad. Lee publicaciones, feeds, espacios y miembros, publica en nombre de tu gente y recibe cada evento por webhook, todo desde una sola API JSON.
Capacidades
Todo lo que necesitas para integrar
Claves de API con ámbitos
Crea claves en la consola de administración de tu comunidad y concede a cada una solo los ámbitos que necesita. Autentica con la cabecera X-API-Key: no hay sesión que gestionar.
Growth o superior
API JSON
Lee y escribe en tu comunidad a través de un único sobre de respuesta. Todos los endpoints viven bajo /site_open_api/v1, aceptan POST con cuerpo JSON y deducen la comunidad a partir de tu clave.
Growth o superior
Webhooks
Registra endpoints para recibir los eventos según ocurren. Cada entrega lleva un event_id estable con el que deduplicar los reintentos, y ese mismo id llega a Slack, Discord y Zapier.
Growth o superior
Integraciones
Conecta Slack, Discord y Zapier desde el centro de integraciones, explora el catálogo de aplicaciones y gestiona en un solo sitio todo lo que tengas conectado.
Inicio de sesión único
Centraliza la autenticación de tu equipo y de tus miembros en lugar de mantener un segundo juego de credenciales.
Business o superior
Registros de entrega
Cada intento de entrega de webhook queda registrado con su payload y su respuesta. Revisa una entrega fallida, comprueba qué devolviste y reintenta desde la consola.
Growth o superior
24 endpoints, un solo sobre
Todo vive bajo https://api.mateflow.com/site_open_api/v1 y usa POST con cuerpo JSON. Estos son los que suelen usarse primero; la lista completa está en la referencia.
- POST/capabilities/getsin ámbitoComprobar tu clave, ámbitos y cuota restante
- POST/site/getsite.readLeer el perfil y los ajustes de la comunidad
- POST/feed/listcontent.readRecorrer el feed de la comunidad
- POST/post/searchcontent.readBuscar publicaciones
- POST/post/createcontent.writePublicar como un miembro
- POST/space/listspaces.readListar los espacios visibles para el observador
- POST/member/lookupmembers.readResolver un correo a un miembro
- POST/media/get_tokenmedia.writeObtener un token de subida de medios
Primeros pasos
Empieza en tres pasos
Activa el acceso a la API
El acceso a la API es una función del plan que habilita la persona propietaria de la comunidad. Sin ella, cada llamada devuelve 22203 y no se puede crear ninguna clave: empieza por aquí, no por tu código.
Crea una clave con ámbitos
Administración de la comunidad → Integraciones → API Keys. Marca solo los ámbitos que necesites: quedan fijados en cuanto la clave existe. La clave completa se muestra una sola vez.
Llama primero a /capabilities/get
Te dice tus ámbitos, si el acceso a la API está activo y cuánta cuota queda; y es el único endpoint que sigue respondiendo cuando el plan o la cuota bloquean todo lo demás. No consume cuota.
Uso y límites
Qué permite cada plan
La cuota diaria cuenta todas las peticiones que superan la autenticación y se reinicia a las 00:00 UTC. Una cuota de cero es una puerta cerrada, no un valor sin configurar: devuelve 22204 en cada llamada.
| Plan | API abierta | Peticiones al día | Endpoints de webhook |
|---|---|---|---|
| Starter | No incluido | — | — |
| Growth | Incluido | 5,000 | 5 |
| Business | Incluido | 10,000 | 20 |
| Enterprise | Incluido | Ilimitado | Ilimitado |
Además de la cuota diaria se aplican límites de ráfaga por clave: consulta los límites de tasa en la referencia.
Tu primera llamada, de tres formas
La misma petición en cada lenguaje: confirma que la clave funciona antes de escribir nada más. Sustituye mfk_xxx por una clave real de tu consola.
curl -X POST \
https://api.mateflow.com/site_open_api/v1/capabilities/get \
-H "X-API-Key: mfk_xxx" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch(
"https://api.mateflow.com/site_open_api/v1/capabilities/get",
{
method: "POST",
headers: {
"X-API-Key": process.env.MATEFLOW_API_KEY,
"Content-Type": "application/json",
},
// Endpoints that take no parameters still want a JSON body.
body: "{}",
},
);
const { code, data } = await res.json();
// Branch on `code`, never on the HTTP status:
// 22203 and 22204 are 403, and only 10202 is throttling.
if (code !== 0) throw new Error(`Mateflow API error ${code}`);
console.log(data.scopes, data.quota_used, data.quota_limit);import os, requests
res = requests.post(
"https://api.mateflow.com/site_open_api/v1/capabilities/get",
headers={"X-API-Key": os.environ["MATEFLOW_API_KEY"]},
json={},
)
body = res.json()
if body["code"] != 0:
raise RuntimeError(f"Mateflow API error {body['code']}")
print(body["data"]["scopes"], body["data"]["api_access"])Contrato OpenAPI
El contrato legible por máquina cubre cada ruta y cada esquema de petición y respuesta, y sirve para cualquier generador de clientes. Los SDK oficiales están en la hoja de ruta; hasta entonces, genera el tuyo.
Referencia
La referencia completa de la API
Ámbitos, paginación, idempotencia, códigos de error, límites de tasa, deduplicación de webhooks y el puñado de excepciones que solo muerden cuando ya estás en producción.
¿Listo para construir?
Crea una cuenta, genera tus claves de API y empieza a integrar Mateflow en tus flujos de trabajo.
Prueba gratis de 14 días · Sin tarjeta de crédito