Pular para o conteúdo principal
A API pública dá ao seu sistema acesso aos dados e às ações do painel da Assiny, sem precisar entrar no painel. Toda chamada usa uma chave de API da sua organização, e cada chave só acessa os projetos liberados para ela.

Catálogo

Criar e editar produtos e ofertas, um por vez ou em lote, e criar funis para receber o link do checkout.

Operação

Listar vendas com filtros, ver o detalhe de cada uma, administrar assinaturas e parcelamentos e responder a pedidos de reembolso.

Antes de começar

Você vai precisar de três coisas. Uma chave de API da sua organização. Ela é gerada pela equipe da Assiny e enviada a você uma única vez. Peça a sua pelo suporte, dizendo quais projetos a chave deve acessar. O ID do projeto (UUID) de cada projeto que você vai usar. Ele aparece no endereço do painel, depois de /projects/. Um servidor para fazer as chamadas. A chave dá acesso aos dados de venda e de compradores, então ela nunca deve ir para o navegador, o app ou um repositório de código.
A guarda da chave é responsabilidade sua. Trate a chave como uma senha: a Assiny não consegue mostrar a mesma chave de novo e não se responsabiliza pelo uso de uma chave que vazar do seu lado. Se suspeitar de vazamento, peça ao suporte para revogá-la na mesma hora e gerar outra — a chave revogada para de funcionar imediatamente.

Endereço base

Todos os caminhos ficam depois de:

Rotas disponíveis

Operação

Por onde seguir

Autenticação

Os cabeçalhos de toda chamada e onde vai o projeto

Primeira chamada

Testar a chave no Postman ou pelo terminal

Erros

O formato do erro e o que fazer em cada status

Usar com IA

O texto para colar no seu assistente de código
Para receber um aviso a cada evento, em vez de consultar, veja Introdução aos webhooks.