zankh

Comece aqui

Cadastrar uma loja

A única rota sem autenticação: cria a loja, a conta do dono e devolve a primeira chave de API.

Todas as páginas

POST /v1/stores é a única rota pública da API. Ela cria a loja, a conta do dono e a primeira chave de API na mesma chamada — de propósito: exigir uma chave para criar a loja que emite a chave seria um ciclo, e quem integra precisa conseguir sair do zero com um curl.

  • POST/v1/storesCadastra a loja + a conta do dono e devolve a primeira chave.sem chave

Faça agora, nesta página

O formulário abaixo chama exatamente essa rota, ao vivo, contra a API de produção. O que ele devolver é uma loja de verdade.

Não sabe a latitude/longitude? Abra o Google Maps, clique com o botão direito no endereço da loja e clique nas coordenadas para copiar.

Pelo terminal

Requisição
curl -X POST https://api.zankhapi.com.br/v1/stores \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Minha Loja",
    "address": "Av. Paulista, 1000, São Paulo - SP",
    "latitude": -23.5613,
    "longitude": -46.6565,
    "ownerEmail": "[email protected]",
    "ownerPassword": "escolha-uma-senha-forte"
  }'
Resposta 201
{
  "data": {
    "store": {
      "id": "1f2e...",
      "slug": "minha-loja",
      "name": "Minha Loja",
      "sellerType": "marketplace_only"
    },
    "apiKey": {
      "key": "zk_live_...",
      "note": "Chave inicial"
    }
  }
}

Campos

CampoTipoDescrição
nameobrigatóriostringO nome da loja, como o comprador vai vê-lo.
addressobrigatóriostringEndereço de origem. É de onde o frete é cotado e onde a transportadora coleta.
latitudeobrigatórionumberCoordenada do endereço — usada na busca por proximidade do marketplace e do agente.
longitudeobrigatórionumberIdem.
ownerEmailobrigatóriostringE-mail do dono. Vira o login do painel administrativo.
ownerPasswordobrigatóriostringSenha do dono, mínimo 8 caracteres.

O mesmo e-mail e senha entram no painel administrativo da loja, em zankh.com.br/admin — é lá que se gerenciam chaves, fotos, categorias, frete e os pedidos que a API não cobre.

Erros

HTTPCódigoO que aconteceu
409email_in_useJá existe uma conta com esse e-mail. Entre no painel e gere uma chave por lá.
422validation_errorAlgum campo faltou ou veio no formato errado — veja issues.