Programadores

Construa sobrea API da Mateflow.

Uma chave, uma comunidade. Leia publicações, feeds, espaços e membros, publique em nome das suas pessoas e receba cada evento por webhook — tudo a partir de uma única API JSON.

Recursos

Tudo o que você precisa para integrar

Chaves de API com escopos

Crie chaves no console de administração da sua comunidade e conceda a cada uma apenas os escopos de que ela precisa. A autenticação usa o cabeçalho X-API-Key — não há sessão para gerenciar.

Growth ou superior

API JSON

Leia e escreva na sua comunidade através de um único envelope consistente. Todos os endpoints ficam sob /site_open_api/v1, aceitam POST com corpo JSON e deduzem a comunidade a partir da sua chave.

Growth ou superior

Webhooks

Registre endpoints para receber eventos assim que acontecem. Cada entrega traz um event_id estável para você deduplicar as retentativas, e esse mesmo id chega ao Slack, ao Discord e ao Zapier.

Growth ou superior

Integrações

Conecte Slack, Discord e Zapier pelo hub de integrações, explore o catálogo de aplicativos e gerencie tudo o que estiver conectado em um só lugar.

Logon único

Centralize a autenticação da sua equipe e dos seus membros em vez de manter um segundo conjunto de credenciais.

Business ou superior

Registros de entrega

Cada tentativa de entrega de webhook fica registrada com o payload e a resposta. Examine uma entrega que falhou, veja o que você devolveu e tente novamente pelo console.

Growth ou superior

24 endpoints, um envelope

Tudo fica sob https://api.mateflow.com/site_open_api/v1 e usa POST com corpo JSON. Estes são os que a maioria das integrações usa primeiro — a lista completa está na referência.

BASE URLhttps://api.mateflow.com/site_open_api/v1

POST/capabilities/getsem escopoVerificar sua chave, escopos e cota restante
POST/site/getsite.readLer o perfil e as configurações da comunidade
POST/feed/listcontent.readPercorrer o feed da comunidade
POST/post/searchcontent.readPesquisar publicações
POST/post/createcontent.writePublicar como um membro
POST/space/listspaces.readListar os espaços visíveis para o observador
POST/member/lookupmembers.readResolver um e-mail para um membro
POST/media/get_tokenmedia.writeObter um token de envio de mídia

Ver todos os endpoints

Primeiros passos

Comece em três passos

Passo 01

Ative o acesso à API

O acesso à API é um recurso do plano que a pessoa dona da comunidade habilita. Sem ele, cada chamada devolve 22203 e nenhuma chave pode ser criada — comece por aqui, não pelo seu código.

Passo 02

Crie uma chave com escopos

Administração da comunidade → Integrações → API Keys. Marque apenas os escopos de que precisa; eles ficam fixos assim que a chave existe. A chave completa é exibida uma única vez.

Passo 03

Chame /capabilities/get primeiro

Ele informa seus escopos, se o acesso à API está ativo e quanta cota resta — e é o único endpoint que ainda responde quando o plano ou a cota bloqueiam todo o resto. Não consome cota.

Uso e limites

O que cada plano permite

A cota diária conta toda requisição que passa pela autenticação e é reiniciada às 00:00 UTC. Uma cota de zero é uma porta fechada, não um valor não configurado: ela devolve 22204 em todas as chamadas.

Plano	API aberta	Requisições por dia	Endpoints de webhook
Starter	Não incluído	—	—
Growth	Incluído	5,000	5
Business	Incluído	10,000	20
Enterprise	Incluído	Ilimitado	Ilimitado

Além da cota diária há limites de rajada aplicados por chave — veja limites de taxa na referência.

Sua primeira chamada, de três formas

A mesma requisição em cada linguagem: confirme que a chave funciona antes de escrever qualquer outra coisa. Substitua mfk_xxx por uma chave real do seu console.

cURL

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 '{}'

JavaScript

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);

Python

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

O contrato legível por máquina cobre cada caminho e cada esquema de requisição e resposta, e alimenta qualquer gerador de clientes. SDKs oficiais estão no roteiro; até lá, gere o seu.

Baixar openapi.json

Referência

A referência completa da API

Escopos, paginação, idempotência, códigos de erro, limites de taxa, deduplicação de webhooks — e o punhado de exceções que só mordem depois que você publica.

Ler a referência Baixar openapi.json

Pronto para construir?

Crie uma conta, gere suas chaves de API e comece a integrar a Mateflow aos seus fluxos de trabalho.

Iniciar teste grátis Falar com engenharia

Teste gratuito de 14 dias · Sem cartão de crédito