<!-- https://www.akrus.digital/docs · revisado em 2026-10-08 · gerado do mesmo conteúdo da página HTML -->
_Dev Docs · v1 em prévia_

# Documentação para desenvolver com a Akrus.

Conceitos da plataforma, guias de checkout e entrega, referência da API e procedimentos para operar sua integração.

> **Antes de integrar**
>
> Contrato em prévia. A implementação foi validada localmente; a liberação em produção ainda precisa ser confirmada pela equipe. O acesso programático exige plano Scale efetivo, credencial e escopos autorizados. Solicite acesso e a URL do ambiente antes de integrar.
>
> [Ver disponibilidade](https://www.akrus.digital/docs/ambientes)

- [Visão da plataforma](https://www.akrus.digital/docs/plataforma) — Conheça os contextos da plataforma e o caminho entre produto, compra e entrega antes de conectar outro sistema.
- [Conceitos e dados](https://www.akrus.digital/docs/conceitos) — Modele sua integração com os mesmos conceitos usados pela Akrus, preservando identificadores, estados e unidades.
- [Checkout](https://www.akrus.digital/docs/checkout) — Use o link publicado da oferta e acompanhe a compra sem confundir navegação, pagamento e entrega.
- [Área de membros](https://www.akrus.digital/docs/membros) — A concessão informa a permissão de acesso. Ela não identifica o aluno e não substitui uma sessão de autenticação.
- [Guias de integração](https://www.akrus.digital/docs/integracoes) — Relatórios, catálogo e conferência de acessos usam o contrato de leitura. Outros fluxos precisam de recursos próprios.
- [Início rápido](https://www.akrus.digital/docs/inicio-rapido) — Prepare um ambiente autorizado e uma credencial com o escopo adequado.
- [Autenticação](https://www.akrus.digital/docs/autenticacao) — Envie a credencial no cabeçalho Authorization em cada consulta.
- [Ambientes e disponibilidade](https://www.akrus.digital/docs/ambientes) — A documentação de um contrato não comprova a disponibilidade de um serviço em produção.
- [Referência da API](https://www.akrus.digital/docs/api) — A v1 expõe coleções de produtos, vendas e concessões de acesso vinculadas ao produtor da credencial.
- [API de produtos](https://www.akrus.digital/docs/api/produtos) — Lista os produtos vinculados ao produtor da credencial. Não cria nem altera produtos.
- [API de vendas](https://www.akrus.digital/docs/api/vendas) — Lista vendas reais do produtor. Valores em reais são representados em centavos. O recurso não retorna nome, e-mail, documento, telefone ou identificador do perfil do comprador.
- [API de acessos](https://www.akrus.digital/docs/api/acessos) — Lista concessões de acesso. Uma concessão pode ser reutilizada após uma recompra: esta coleção não representa um histórico de matrículas. A relação com a venda é feita por sale_id, sem identificar a pessoa.
- [Paginação](https://www.akrus.digital/docs/paginacao) — Use limit para escolher o tamanho da página e next_cursor para continuar.
- [Erros](https://www.akrus.digital/docs/erros) — Os erros têm um envelope consistente. Use error.code na lógica da integração; a mensagem pode mudar.
- [Limites de uso](https://www.akrus.digital/docs/limites) — O contrato inicial limita cada credencial a 600 requisições por janela móvel de 60 segundos.
- [Sincronização e reconciliação](https://www.akrus.digital/docs/sincronizacao) — Uma carga inicial não mantém os dados atualizados. Planeje paginação, retomada e releitura dos registros antigos.
- [Segurança da integração](https://www.akrus.digital/docs/seguranca) — Mantenha as chamadas no servidor, separe os produtores e registre diagnósticos sem expor segredos.
- [Homologação](https://www.akrus.digital/docs/homologacao) — Use cenários controlados para provar leitura, continuidade e tratamento de falhas no ambiente autorizado.
- [Webhooks](https://www.akrus.digital/docs/webhooks) — Webhooks notificam outro sistema quando algo acontece. Sua disponibilidade precisa ser confirmada antes de usar esse caminho.
- [SDKs e exemplos](https://www.akrus.digital/docs/sdks) — Os exemplos usam HTTP diretamente. Não há SDK oficial ou coleção de ferramentas para download publicada nesta documentação.
- [Glossário](https://www.akrus.digital/docs/glossario) — Termos de produto e de integração com o significado usado nesta referência.
- [Versões da API](https://www.akrus.digital/docs/changelog) — Referência da v1 documentada. Este registro não anuncia uma liberação em produção.

## Entenda a plataforma

- [Visão da plataforma](https://www.akrus.digital/docs/plataforma) — Do produto à compra, entrega e acompanhamento da operação.
- [Conceitos e dados](https://www.akrus.digital/docs/conceitos) — Produtos, ofertas, vendas, concessões e convenções dos campos.
- [Checkout](https://www.akrus.digital/docs/checkout) — Conecte sua página ao checkout e acompanhe a compra.
- [Área de membros](https://www.akrus.digital/docs/membros) — Entrega, concessões e limites da integração com alunos.
- [Guias de integração](https://www.akrus.digital/docs/integracoes) — Casos de uso, arquitetura e escopo de cada conexão.

## Comece a integração

- [Início rápido](https://www.akrus.digital/docs/inicio-rapido) — Prepare uma primeira consulta com credencial e escopo.
- [Autenticação](https://www.akrus.digital/docs/autenticacao) — Bearer token, escopos e revogação de credenciais.
- [Ambientes e disponibilidade](https://www.akrus.digital/docs/ambientes) — Confirme a liberação antes de conectar uma operação real.
- [Referência da API](https://www.akrus.digital/docs/api) — Produtos, vendas e concessões de acesso, somente leitura.
- [SDKs e exemplos](https://www.akrus.digital/docs/sdks) — Exemplos HTTP sem dependência de um SDK oficial.

## Prepare a operação

- [Sincronização e reconciliação](https://www.akrus.digital/docs/sincronizacao) — Carga inicial, checkpoints, retomada e alterações em registros antigos.
- [Segurança da integração](https://www.akrus.digital/docs/seguranca) — Credenciais, isolamento entre contas e diagnóstico sem segredos.
- [Homologação](https://www.akrus.digital/docs/homologacao) — Cenários de teste e critérios para iniciar a operação.
- [Webhooks](https://www.akrus.digital/docs/webhooks) — Disponibilidade e requisitos para notificações de eventos.
- [Glossário](https://www.akrus.digital/docs/glossario) — Termos de produto e de integração da Akrus.
- [Versões da API](https://www.akrus.digital/docs/changelog) — Escopo da v1 e critérios de compatibilidade.

## Consulte a referência

- [API de produtos](https://www.akrus.digital/docs/api/produtos) — GET /api/v1/products · products:read.
- [API de vendas](https://www.akrus.digital/docs/api/vendas) — GET /api/v1/sales · sales:read.
- [API de acessos](https://www.akrus.digital/docs/api/acessos) — GET /api/v1/access · access:read.
- [Paginação](https://www.akrus.digital/docs/paginacao) — Use limit e next_cursor para percorrer uma coleção.
- [Erros](https://www.akrus.digital/docs/erros) — Códigos HTTP e tratamento de falhas da API v1.
- [Limites de uso](https://www.akrus.digital/docs/limites) — Cota por credencial, Retry-After e tentativas posteriores.

## Roteiro para a primeira integração

1. **Confirme o acesso** — Confirme o plano Scale efetivo, a URL do ambiente e uma credencial com os escopos necessários.
2. **Execute uma consulta** — Use o guia rápido no servidor e confira status HTTP e envelope.
3. **Implemente a continuidade** — Percorra o cursor e trate erros, limites e interrupções.
4. **Valide a operação** — Confira isolamento dos dados, revogação de chave e reconciliação antes de depender da integração.

## Consulte conforme a sua tarefa

| Tarefa | Referência |
| --- | --- |
| Guardar e substituir credenciais | Autenticação e escopos. |
| Ler valores ou concessões | Referências de vendas e acessos. |
| Percorrer todos os registros | Paginação por cursor. |
| Diagnosticar falhas | Erros e limites de requisição. |
| Planejar eventos e ferramentas | Webhooks, SDKs e changelog. |

---

Próximo: [Visão da plataforma](https://www.akrus.digital/docs/plataforma)
