Documentação Akrus · v1 em prévia
Glossário da documentação.
Termos de produto e de integração com o significado usado nesta referência.
Nesta página
Produto e operação
| Termo | Significado |
|---|---|
| Akrus | Plataforma para vender, acompanhar a operação e entregar produtos digitais. |
| Produtor | Conta responsável pelo produto e pelos dados vinculados à credencial. |
| Comprador / aluno | Pessoa que compra ou acessa o conteúdo; sua identidade não é retornada na API v1. |
| Produto | Item que organiza o que será vendido e entregue. |
| Oferta | Condições comerciais associadas à compra de um produto. |
| Checkout | Etapa em que o comprador confere a oferta e realiza o pagamento. |
| Venda | Registro da compra com estado e valores; pode estar pendente. |
| Concessão | Registro da permissão de acesso ao produto, que pode ser revogada ou reutilizada. |
| Área de membros | Experiência de consumo do conteúdo disponibilizado pelo produtor. |
| Saldo Akrus | Saldo da operação, distinto do valor líquido de uma única venda. |
| Scale | Plano exigido pelo contrato implementado para acesso programático à API v1. |
API e integração
| Termo | Significado |
|---|---|
| Credencial | Segredo apresentado no cabeçalho Authorization para autorizar as consultas. |
| Bearer | Forma de enviar a credencial: Authorization: Bearer <credencial>. |
| Escopo | Permissão de leitura de um recurso, como products:read. |
| Endpoint | Combinação de método HTTP e caminho, como GET /api/v1/products. |
| Envelope | Estrutura que envolve os dados ou o erro e informa version. |
| Cursor | Valor opaco que posiciona a próxima página; deve ser reutilizado sem alteração. |
| Checkpoint | Ponto de retomada salvo pela integração após concluir a persistência da página. |
| Reconciliação | Releitura para atualizar estados e conferir divergências na cópia local. |
| Idempotência local | Reprocessar uma página sem criar registros ou efeitos duplicados no seu sistema. |
| Retry-After | Cabeçalho que informa quantos segundos aguardar após atingir o limite. |
| Webhook | Notificação enviada a outro sistema; sem contrato público de assinatura liberado nesta referência. |
| Prévia | Contrato documentado cuja liberação e ambiente precisam ser confirmados antes do uso. |
Volte ao conceito em contexto
Conceitos e dados
Produtos, ofertas, vendas, concessões e convenções dos campos.
Referência da API
Produtos, vendas e concessões de acesso, somente leitura.
Sincronização e reconciliação
Carga inicial, checkpoints, retomada e alterações em registros antigos.
Referência conferida em 8 de outubro de 2026. Relatar uma dúvida na documentação.