Documentacao da API

Aprenda a integrar a API Mercozy para gerenciar produtos, pedidos, estoque e muito mais.

Primeiros Passos

Obtenha sua chave API

Faça login como Admin e vá para Configurações > Integração > Chaves API para gerar uma nova chave. Apenas usuários Admin têm permissão.

Inclua nas requisicoes

Adicione o cabecalho X-API-Key a todas as suas requisicoes API.

Comece a fazer requisicoes

Use qualquer cliente HTTP para interagir com os endpoints da API Mercozy.

Autenticacao

Todas as requisicoes API requerem uma chave API valida enviada pelo cabecalho X-API-Key.

bash

curl https://api.mercozy.com/api/v1/external/products \
  -H "X-API-Key: mk_live_your_key_here"

As chaves API sao vinculadas ao seu tenant. Mantenha-as em segredo e nunca as exponha no codigo do lado do cliente.

URL Base

https://api.mercozy.com/api/v1/external

Limites de Taxa

Os limites de taxa da API dependem do seu plano de assinatura.

Plano	Limite de Taxa	Acesso API
Free / Standard	Sem acesso API	No
Pro	300 req/min	Yes
Business	1,000 req/min	Yes

Formato de Resposta

Todas as respostas sao retornadas em formato JSON.

Resposta de Sucesso

json

{
  "data": [
    {
      "id": "prod_abc123",
      "name": "Premium Widget",
      "price": 2999,
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "limit": 20
  }
}

Resposta de Erro

json

{
  "statusCode": 401,
  "message": "Invalid API key",
  "error": "Unauthorized"
}

Codigos de Erro

Codigo	Status	Descricao
VALIDATION_ERROR	400	Parametros de requisicao invalidos
UNAUTHORIZED	401	Chave API invalida ou ausente
FORBIDDEN	403	Permissoes insuficientes
NOT_FOUND	404	Recurso nao encontrado
CONFLICT	409	Recurso ja existe ou conflito
RATE_LIMITED	429	Muitas requisicoes
INTERNAL_ERROR	500	Erro interno do servidor