API de Integração (FAQ)

1. Para que serve a API da Wake?

A API Pública da Wake é uma interface de arquitetura aberta (API-First) baseada nos protocolos REST e GraphQL. Ela serve para que sistemas externos realizem a leitura, criação, modificação e sincronização passiva de dados estruturados da plataforma (como Catálogo, Clientes, Estoque, Preços e Pedidos), permitindo que a operação funcione de forma integrada e automatizada.

2. Como faço para que meu ERP integre com a plataforma?

A integração do ERP ocorre de forma passiva consumindo os endpoints REST expostos na documentação técnica da API Pública.

• Fluxo de Conexão: É necessário gerar credenciais de acesso exclusivas (Tokens) dentro do painel administrativo da Wake para o parceiro de ERP.
• Webhooks: Para otimizar o fluxo de dados do ERP para a plataforma e evitar consultas redundantes (polling), o desenvolvedor deve assinar os tópicos do Webhook da Wake. Um exemplo prático e recente é o tópico de Preço de Custo Alterado, que dispara uma notificação imediata sempre que houver alteração de valor de uma variante, acelerando a atualização do ecossistema.

3. Quais as regras de funcionamento dos Tokens?

• Validade máxima de 1 ano: todo token de integração passa a ter uma data de expiração, com limite de até 1 ano. Recomendamos renovar a cada 90 dias para maior segurança.
• Token de visualização única: a chave gerada é exibida apenas no momento da criação e não pode ser consultada novamente — copie e guarde-a em um local seguro.
• Rotação de token: é possível rotacionar o token com data de expiração próxima ao vencimento diretamente na listagem, gerando uma nova chave sem perder as permissões já configuradas.
• Inativação automática: tokens sem uso durante o período de 30 dias são inativados automaticamente. Tokens com data expirada são inativados automaticamente, assim como a chave antiga de um token rotacionado.

4. Existe um modelo a ser seguido nas requisições (criação, atualização e consultas)?

Sim. As requisições seguem o padrão arquitetural REST com payloads trafegados estritamente em formato JSON através dos métodos HTTP:

• Consultas: Utilizam o método GET e contam com suporte à paginação baseada em cursor (usando parâmetros como produtoVarianteIdDe), que acelera buscas massivas em até 100 vezes.
• Criações: Utilizam o método POST.
• Atualizações: Utilizam o método PUT para sobrescrita completa ou o método PATCH para atualizações parciais de dados (reduzindo em até 90% a necessidade de banda e requisições).

5. Existe um limite de requisições na API?

Sim. O limite padrão estabelecido na plataforma é de 120 chamadas por minuto, mas com uma regra arquitetural importante: o limite é calculado por grupo de endpoint. Isso significa que a integração pode realizar 120 chamadas simultâneas para o módulo de Pedidos e mais 120 chamadas para o módulo de Produtos dentro do mesmo minuto. O novo motor de barramento de estoque foi otimizado para suportar alta volumetria, sendo até 54 vezes mais rápido no processamento massivo.

6. Se o limite de requisições da API for ultrapassado eu sou notificado?

Sim. Quando o limite de requisições (Rate Limit) por grupo de endpoint é atingido, a plataforma bloqueia temporariamente novas chamadas com o código HTTP padrão e, simultaneamente, dispara alertas e notificações automáticas estruturadas diretamente para o e-mail do Responsável Técnico cadastrado no token da integração.

Para mais detalhes sobre os temas abordados nesse conteúdo acesse o artigo API de Integração.