Pular para o conteúdo
MeWeb

Desenvolvedores

Integrações (API Admin)

Além da Storefront API pública, sistemas de retaguarda (ERP, expedição, automações) podem acessar as rotas administrativas da loja com uma chave de API, uma credencial secreta com escopos limitados, no modelo de apps privados.

Obtendo a chave

Quem gera a chave é o lojista, no admin da loja: Configurações → API → Nova chave. Ele escolhe os escopos (ex.: Pedidos: ver; Estoque: gerenciar) e recebe o segredo mwk_… uma única vez; combine um canal seguro para recebê-lo. Gestão de usuários e configurações nunca são concedíveis a chaves.

Usando

terminal
# A chave vai no header Authorization: só em requisições de servidor
curl -H "Authorization: Bearer mwk_SUACHAVE" \
  "https://SUA-LOJA.meweb.com.br/api/v1/admin/orders?page=1&perPage=25"

# Fora do escopo concedido → 403 FORBIDDEN
# Chave revogada/expirada → 401
Node.js
// Exemplo Node.js (servidor da integração)
const res = await fetch('https://sua-loja.meweb.com.br/api/v1/admin/orders?page=1&perPage=25', {
  headers: { Authorization: `Bearer ${process.env.MEWEB_API_KEY}` },
});
const { data, pageInfo } = await res.json();
// pageInfo: { page, perPage, totalCount, totalPages }; laço: page < totalPages
  • A base é a mesma da loja (https://<slug>.meweb.com.br/api/v1); as rotas administrativas vivem sob /admin/*.
  • Envelope e códigos de erro são os mesmos da Storefront API. A paginação é diferente: as listagens administrativas usam ?page&perPage com perPage em 5, 25, 50 ou 100 e devolvem o total (totalCount/totalPages); a Storefront API pagina por cursor.
  • Limite de 300 req/min por chave. Resposta 429 traz Retry-After.
  • A chave não funciona na Storefront API nem nas rotas de sessão: é exclusiva do escopo administrativo.

Guarda do segredo

  • Só em servidor. Nunca em site, aplicativo, repositório ou planilha: qualquer um com o segredo opera a loja nos escopos concedidos.
  • Use variável de ambiente/cofre de segredos no seu deploy.
  • Vazou? O lojista revoga na hora em Configurações → API (efeito imediato) e gera outra.
  • Prefira uma chave por integração: facilita revogar sem derrubar as demais.

Referência das rotas administrativas

A referência pública desta seção cobre a Storefront API. Os contratos das rotas /admin/* seguem as mesmas convenções; a documentação endpoint a endpoint está em evolução; fale com a nossa equipe sobre os recursos que a sua integração precisa.