Comece aqui

Autenticação

Uma chave, uma loja. Como enviá-la, onde gerá-la e por que ela nunca vai para o navegador.

Todas as páginas

Toda rota, exceto POST /v1/stores e POST /v1/partners, exige a chave no cabeçalho Authorization:

 
curl https://api.zankhapi.com.br/v1/me \
  -H "Authorization: Bearer zk_live_..."

Uma chave pertence a uma loja e só enxerga os dados dela. Não existe parâmetro de loja em rota nenhuma — o escopo vem da chave, não do corpo da requisição, então não há como uma variável errada no seu script escrever no catálogo de outra pessoa.

Onde gerar e revogar

  • A primeira chave volta na resposta de `POST /v1/stores`.
  • As demais são criadas e revogadas no painel da loja, em Chaves de API. Uma chave revogada responde 401 revoked_api_key imediatamente.
  • Gere uma chave por integração (ERP, script de importação, ferramenta de IA). Revogar uma não derruba as outras.

Confirme que funcionou

GET /v1/me devolve a loja da chave. É o teste de fumaça de toda integração — e vale rodá-lo antes de qualquer escrita, para confirmar em qual loja você está.

  • GET/v1/meA loja a que esta chave pertence (id, slug, name, sellerType).
Resposta 200
{
  "data": {
    "id": "1f2e...",
    "slug": "minha-loja",
    "name": "Minha Loja",
    "sellerType": "marketplace_only"
  }
}

Erros de autenticação

HTTPCódigoO que aconteceu
401missing_api_keyNão veio o cabeçalho Authorization: Bearer ....
401invalid_api_keyA chave não foi reconhecida.
401revoked_api_keyA chave foi revogada no painel.
403store_inactiveA loja está desativada na zankh.
403subscription_suspendedA assinatura da loja está suspensa por falta de pagamento. Toda rota responde isso até a fatura em aberto ser paga.