EcomDocs

Começando

Descubra a URL base da sua loja, faça login e realize sua primeira chamada autenticada em minutos.

3 min de leituraAtualizado em 14 de agosto de 2026

A API do Ecom é REST, com respostas em JSON e códigos de status HTTP convencionais. Cada loja tem sua própria URL base, e a autenticação já identifica a sua loja. Este guia leva você do zero à primeira requisição autenticada.

1. Identifique a URL base

Toda requisição usa a URL base da API api.ecomplataforma.com.br. A autenticação já identifica a sua loja. O storefront público de cada loja vive em <loja>.ecomplataforma.com.br.

bash
# A URL base da API
https://api.ecomplataforma.com.br

# Verificação rápida de disponibilidade
curl https://api.ecomplataforma.com.br/health

2. Faça login no painel

O login do painel devolve um cookie httpOnly (ecom_token). Guarde o cookie e reutilize-o nas próximas chamadas de administração.

bash
curl -X POST "https://api.ecomplataforma.com.br/auth/login" \
  -H "Content-Type: application/json" \
  -c cookies.txt \
  -d '{"email":"admin@minha-loja.com","senha":"sua-senha"}'

3. Chame um endpoint autenticado

bash
curl "https://api.ecomplataforma.com.br/products" -b cookies.txt

Recebeu 200 com { success: true, data: [...] }? Está tudo pronto. Explore a Referência da API para todos os endpoints.

AnteriorFrete, cupons e marketingPróximoAutenticação