Dev Docs · v1 em prévia

Documentação para desenvolver com a Akrus.

O contrato da API pública v1, organizado para sua primeira consulta e para a operação diária.

O que está documentado

Início rápido
Prepare uma primeira consulta com credencial e escopo.
Referência da API
Produtos, vendas e concessões de acesso, somente leitura.
Autenticação
Bearer token, escopos e revogação de credenciais.
Paginação
Use limit e next_cursor para percorrer uma coleção.
Erros
Códigos HTTP e tratamento de falhas da API v1.
Limites de uso
Cota por credencial, Retry-After e tentativas posteriores.
Ambientes e disponibilidade
Confirme a liberação antes de conectar uma operação real.
Versões da API
Escopo da v1 e critérios de compatibilidade.

Confirme o acesso
Solicite 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.

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 23 de setembro de 2026. Relatar uma dúvida na documentação.