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.
Nesta página
Entenda a plataforma
Visão da plataforma
Do produto à compra, entrega e acompanhamento da operação.
Conceitos e dados
Produtos, ofertas, vendas, concessões e convenções dos campos.
Checkout
Conecte sua página ao checkout e acompanhe a compra.
Área de membros
Entrega, concessões e limites da integração com alunos.
Guias de integração
Casos de uso, arquitetura e escopo de cada conexão.
Comece a integração
Início rápido
Prepare uma primeira consulta com credencial e escopo.
Autenticação
Bearer token, escopos e revogação de credenciais.
Ambientes e disponibilidade
Confirme a liberação antes de conectar uma operação real.
Referência da API
Produtos, vendas e concessões de acesso, somente leitura.
SDKs e exemplos
Exemplos HTTP sem dependência de um SDK oficial.
Prepare a operação
Sincronização e reconciliação
Carga inicial, checkpoints, retomada e alterações em registros antigos.
Segurança da integração
Credenciais, isolamento entre contas e diagnóstico sem segredos.
Homologação
Cenários de teste e critérios para iniciar a operação.
Webhooks
Disponibilidade e requisitos para notificações de eventos.
Glossário
Termos de produto e de integração da Akrus.
Versões da API
Escopo da v1 e critérios de compatibilidade.
Roteiro para a primeira integração
Confirme o acesso
Confirme o plano Scale efetivo, a URL do ambiente e uma credencial com os escopos necessários.
Execute uma consulta
Use o guia rápido no servidor e confira status HTTP e envelope.
Implemente a continuidade
Percorra o cursor e trate erros, limites e interrupções.
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. |
Referência conferida em 8 de outubro de 2026. Relatar uma dúvida na documentação.