Integrações · API REST e webhooks

Cada botão do painel, como endpoint

Uma API REST versionada e 191 eventos de webhook assinados, atrás de tokens cujo escopo você define, em todos os planos

Tudo o que o painel pode fazer, o código pode fazer: 40 famílias de recursos numa API versionada descrita por uma especificação OpenAPI publicada, tokens de acesso pessoal que só transportam as permissões que marca, escritas que aceitam uma chave de idempotência para que uma repetição nunca duplique, e 191 eventos enviados aos seus endpoints com uma assinatura HMAC e uma escada de repetições que continua a tentar durante cerca de 4 dias. O endpoint REST e a ferramenta MCP de uma operação partilham a mesma ação por baixo, por isso um agente, um Zap e o seu próprio serviço fazem todos exatamente o que o painel faria.

Superfície
40 famílias de recursos
Projetos, planos, passes, assinaturas, membros, cupons, códigos de acesso, transmissões, suporte, conectores, recuperação e mais, em um caminho versionado com uma especificação OpenAPI publicada.
Tokens
130 permissões com escopo
Um token de acesso pessoal carrega só as permissões que você marca; tokens de produção e de teste se distinguem pelo prefixo e são recusados no ambiente errado.
Limites
300 por minuto, 10,000 por hora, por token
Mais cotas mais rígidas em alguns endpoints pesados; cada resposta diz quanto resta e uma requisição limitada diz quando tentar de novo.
Webhooks
191 eventos assinados
HMAC-SHA256 sobre o carimbo de tempo e o corpo, um registro de entregas e 8 tentativas ao longo de cerca de 4 dias quando seu endpoint está fora do ar.
Idempotência
Repetições respondidas por 24 horas
Envie uma chave de idempotência com uma escrita e uma nova tentativa devolve a primeira resposta em vez de um segundo registro.
Incluído no
Todos os planos, inclusive o Free
A API, os webhooks, a especificação OpenAPI e o servidor MCP não custam nada a mais em nenhum plano.

O que a API lhe dá

Uma especificação, qualquer conjunto de ferramentas

O documento OpenAPI importa-se para o Postman ou o Insomnia para explorar, para um gerador de código para um cliente tipado, e para um toolkit LangChain para um agente, sem cliente escrito à mão.

Privilégio mínimo, por permissão

Os tokens transportam permissões, não papéis: um serviço de relatórios tem as leituras de que precisa e nada mais, um serviço de checkout tem uma única escrita, e rodar um token para tudo o que o usava.

Eventos em que pode confiar

Cada webhook é assinado, repetido numa escada que se alarga e registado em cada tentativa; os corpos das mensagens dos eventos de suporte ficam fora do payload, obtidos pela API quando precisar deles.

Construída a pensar nos agentes

O endpoint REST e a ferramenta MCP de uma operação partilham uma ação, os códigos de erro são um catálogo que pode ler, e as tarefas assíncronas reportam o seu progresso, por isso uma máquina pode conduzir a plataforma tão seguramente como uma pessoa.

Como começar

  1. 1

    Crie um token de acesso pessoal em Configurações, Tokens de API, marcando apenas as permissões de que precisa; use primeiro um token de teste contra um projeto de teste.

  2. 2

    Importe a especificação OpenAPI para o Postman ou o Insomnia, ou gere um cliente tipado a partir dela, e faça a sua primeira leitura.

  3. 3

    Adicione um cabeçalho de chave de idempotência a cada escrita, para que uma repetição após um timeout devolva a primeira resposta.

  4. 4

    Adicione um endpoint de webhook, escolha os eventos, guarde o segredo e verifique a assinatura de cada entrega antes de agir sobre ela.

  5. 5

    Acompanhe o registo de entregas e os cabeçalhos de limite de pedidos, e leia a página de versionamento antes de construir sobre algo marcado como em mudança.

Leia o guia

Ideal para

  • Programadores que constroem um checkout, uma sincronização com CRM ou um serviço de relatórios
  • Agências que gerem muitas comunidades a partir de um só sistema
  • Quem quer que a plataforma se adapte à sua stack e não o contrário

Perguntas Frequentes

Leia o guia
A API está no plano Free?
Sim. A API, os webhooks, a especificação OpenAPI e o servidor MCP estão em todos os planos, inclusive o Free, com os mesmos limites.
Como o escopo dos tokens é definido?
Por permissão, entre 130: você marca o que um token pode fazer ao criá-lo, e uma requisição fora dessa lista é recusada com um erro claro. Tokens de produção e de teste carregam prefixos diferentes e são recusados no ambiente errado.
Quais são os limites de taxa?
300 requisições por minuto e 10,000 por hora por token, com cotas mais rígidas em alguns endpoints pesados como a geração em massa de códigos; os cabeçalhos de resposta dizem quanto resta e uma requisição limitada diz quando tentar de novo.
O que acontece quando meu endpoint de webhook está fora do ar?
O Subscriby tenta a entrega de novo até 8 vezes ao longo de cerca de 4 dias em uma escada crescente, registra cada tentativa e marca a entrega quando seu endpoint responde com sucesso. As entregas não são rigorosamente ordenadas em novas tentativas, então aja pelos dados do evento e não pela ordem de chegada.
Como evito duplicatas em novas tentativas?
Envie uma chave de idempotência com cada escrita. Uma repetição com a mesma chave dentro de 24 horas devolve a resposta que a primeira tentativa recebeu, então uma requisição repetida nunca cria um segundo código, cupom ou resposta.

Comece grátis — Leia a especificação, faça a primeira chamada

Free Plan includes 3 projects. No monthly fee — card on file required to charge transaction fees.

Configure Gratuitamente em 30 Minutos
Nossos Roadmaps