Documentação Akrus · v1 em prévia
Escolha a integração pelo resultado esperado.
Relatórios, catálogo e conferência de acessos usam o contrato de leitura. Outros fluxos precisam de recursos próprios.
Nesta página
Casos de uso e limites
| Projeto | Dados ou caminho | Limite a considerar |
|---|---|---|
| Catálogo externo | products:read | Campos de catálogo; sem preço, imagem ou URL de checkout publicados na resposta. |
| Relatório de vendas | sales:read | Centavos de real e estados; sem dados pessoais ou extrato financeiro. |
| Conferência de entrega | sales:read e access:read | Relacionamento por sale_id; sem identidade do aluno. |
| Página de vendas própria | Link de checkout da oferta | Sem necessidade de expor credencial no navegador. |
| CRM e campanhas | Avaliar conectores e permissões disponíveis | A v1 não fornece e-mails ou telefones para alimentar contatos. |
| Eventos em tempo real | Consultar a referência de webhooks | Sem assinatura pública de eventos documentada. |
| Migração de alunos ou conteúdo | Planejamento com a equipe | A v1 não importa produtos nem concede acessos. |
Arquitetura sugerida para leitura
Organização do sistema integrador, não um serviço adicional oferecido pela Akrus.
Agendador da sua aplicação
→ Processo no servidor com credencial protegida
→ GET /api/v1/products, /sales ou /access
→ Validação de status, envelope e paginação
→ Persistência por conta + recurso + id
→ Relatório autorizado da sua aplicação
Reconciliação periódica → atualiza registros antigosFerramentas de automação e conectores
Uma ferramenta capaz de fazer requisições HTTP pode consumir a API autorizada se proteger a credencial, respeitar os limites e tratar paginação e falhas. Isso não torna a ferramenta ou seu conector um produto oficial da Akrus.
Configure uma conexão por produtor e restrinja quem pode visualizar ou exportar suas credenciais. Antes de usar um intermediário, confira quais dados ele armazena e quem terá acesso ao histórico de execuções.
Consulte a página de integrações para conhecer o estado dos conectores apresentados pela Akrus. A existência de um conector no painel não libera rotas internas para uso programático por terceiros.
Defina o escopo antes de implementar
Dados
- Liste os campos realmente necessários e compare com a referência.
- Solicite somente os escopos usados pelo projeto.
- Defina a conta proprietária dos dados e a separação entre clientes.
Operação
- Estabeleça a tolerância a atraso e o intervalo de reconciliação.
- Estime páginas, frequência e processos que compartilham a cota.
- Registre o comportamento esperado quando o plano ou a credencial perder acesso.
Planeje a implementação
Desenvolvedores
Sincronização e reconciliação
Carga inicial, checkpoints, retomada e alterações em registros antigos.
Desenvolvedores
Segurança da integração
Credenciais, isolamento entre contas e diagnóstico sem segredos.
Desenvolvedores
Homologação
Cenários de teste e critérios para iniciar a operação.
Plataforma
Integrações
Consulte o que está disponível e o que está previsto.
Plataforma
Migrar para a Akrus
Planeje produtos, alunos e acessos antes da mudança.
Referência conferida em 8 de outubro de 2026. Relatar uma dúvida na documentação.