Akrus Developers
Documentação para construir com a Akrus.
Entenda a plataforma, conecte sua operação e consulte a referência da API. Do primeiro link de checkout à sincronização de produtos, vendas e acessos.
- v1 em prévia
- Somente leitura
- Escopos por recurso
O contrato em números
- recursos de leitura: produtos, vendas e acessos
- 3
- versão do envelope de sucesso e de erro
- v1
- registros por página, no máximo (padrão 50)
- 100
- requisições por credencial a cada 60 segundos
- 600
Uma API de leitura
A v1 documentada tem três recursos e usa uma credencial vinculada ao produtor. As consultas retornam apenas os campos publicados e respeitam os escopos concedidos.
Comece pelo guia rápido para entender a primeira consulta. Se já está planejando a integração, consulte a referência de recursos, os limites e o comportamento dos erros.
- GET /api/v1/products · products:read
- GET /api/v1/sales · sales:read
- GET /api/v1/access · access:read
Escolha seu caminho
Desenvolvedores
Visão da plataforma
Do produto à compra, entrega e acompanhamento da operação.
Desenvolvedores
Checkout
Conecte sua página ao checkout e acompanhe a compra.
Desenvolvedores
Área de membros
Entrega, concessões e limites da integração com alunos.
Desenvolvedores
Guias de integração
Casos de uso, arquitetura e escopo de cada conexão.
Desenvolvedores
Início rápido
Prepare uma primeira consulta com credencial e escopo.
Desenvolvedores
Autenticação
Bearer token, escopos e revogação de credenciais.
Desenvolvedores
Referência da API
Produtos, vendas e concessões de acesso, somente leitura.
Desenvolvedores
Ambientes e disponibilidade
Confirme a liberação antes de conectar uma operação real.
Plataforma
Integrações
Consulte o que está disponível e o que está previsto.
Projetos que cabem no contrato
O que dá para construir hoje com a leitura da v1, e onde o contrato termina.
| Necessidade | Recurso e limite |
|---|---|
| Catálogo de produtos | Consulta dos campos públicos de produtos; edição continua fora da API v1. |
| Relatórios de vendas | Leitura de valores e estados, sem identidade de compradores. |
| Conferência de acessos | Leitura de concessões e relação com vendas; não é histórico de matrículas. |
O que informar ao solicitar acesso
Sobre a integração
- Objetivo da integração e conta responsável pela operação.
- Recursos e escopos necessários.
- Frequência estimada de consultas e sistemas envolvidos.
Sobre a validação
- Responsável técnico e etapa de validação pretendida.
Encontre o guia para sua integração
Explore os conceitos da plataforma, os exemplos e os critérios para operar com segurança.