Pular para o conteúdo
Axiom connect

API aberta

Uma API aberta para o que é só seu.

BI, WMS, app interno ou o sistema legado que ninguém quer desligar: tudo o que a tela mostra também está na API REST.

Ilustração: API aberta no Axiom connect

Em resumo

A API do Axiom connect é uma API REST documentada em português que cobre produtos, categorias, pedidos, estoque, notas fiscais e histórico. O acesso é por tokens de integração — credenciais máquina a máquina com escopo, permissões e validade definidos por quem administra a conta. É o caminho para conectar sistemas que ainda não têm conector.

Principais recursos — API aberta

01 · Tokens

Credenciais com limite claro

Cada token é criado na tela Tokens de integração e já carrega a conta: basta o cabeçalho Authorization.

  • Permissões por recurso, de ver ou de editar
  • Um token nunca recebe mais acesso do que quem o emite
  • O token aparece uma vez só e não fica salvo — se perder, revogue e gere outro
  • Data do último uso visível na lista de tokens

02 · Consultas

Pergunte do jeito que o seu sistema precisa

As listas aceitam filtro, ordenação e relações na mesma chamada.

  • Filtros combinados, como status pago e total acima de um valor
  • Ordenação por campo, crescente ou decrescente
  • Relações incluídas na resposta, como os itens e as remessas do pedido
  • Paginação por cursor para percorrer listas grandes

03 · Casos de uso

O que costuma passar pela API

Quando não há conector pronto, a API cobre a integração.

  • Saldo de estoque informado pelo sistema que controla o físico
  • Pedidos vindos de canais ou sistemas próprios
  • Leitura de pedidos e notas para BI e relatórios
  • Consulta ao histórico de alterações para auditoria

Passo a passo

Como funciona na prática

  1. 1

    Conheça os recursos

    Produtos, categorias, pedidos, estoque, notas fiscais e histórico, documentados em português.

  2. 2

    Gere o token

    Escolha o escopo, as permissões e a validade na tela Tokens de integração.

  3. 3

    Chame a API

    Mande o token no cabeçalho Authorization de cada chamada.

  4. 4

    Acompanhe

    O último uso aparece na lista, e o histórico registra o que o token criou ou alterou.

Perguntas frequentes

Dúvidas sobre api aberta

O que a API cobre?

Produtos, categorias, pedidos, estoque, notas fiscais e histórico, com filtros, ordenação, relações e paginação por cursor.

Como funciona a autenticação?

Por tokens de integração, enviados no cabeçalho Authorization como Bearer. O token já carrega a conta, o escopo e as permissões.

Um token pode ter mais acesso do que eu?

Não. Um token nunca recebe mais acesso do que quem o emite, e vale num escopo só: a conta, uma organização ou uma filial.

Sua operação inteira, conectada num hub só.

Conte quais canais e qual ERP a sua empresa usa. A gente mostra o Axiom rodando com eles e monta o plano de implantação.

  • Implantação acompanhada
  • Configuração por filial
  • Sem trocar de ERP