Pular para o conteúdo principal

Bem-vindo à documentação da Ecommerce APP API

A EAPP API é a interface programática da plataforma CRM. Por meio dela você envia dados de comportamento do seu negócio para a plataforma, identifica clientes e consulta relatórios.

Esta documentação reúne todas as APIs públicas do produto.

Host de produção

https://api-crm.ecommerceapp.com.br

Todas as chamadas seguem o formato https://api-crm.ecommerceapp.com.br/api/v1/<módulo>/....

Princípios da plataforma

  • Um único host, um único prefixo. Todas as chamadas passam pelo API Gateway sob /api/v1/<módulo>/.... Você nunca chama microsserviços internos diretamente.
  • Autenticação por API Key. Todas as rotas exigem Authorization: Bearer <api-key>. Veja Autenticação.
  • Erros HTTP padrão. 200 / 400 / 401 / 403 / 404 / 500 com corpo de erro consistente. Veja Códigos de erro.

O que tem nesta documentação

SeçãoO que você encontra
Início RápidoInstale o script de tracking, obtenha credenciais e dispare o primeiro evento com exemplos em JavaScript e cURL
AutenticaçãoComo usar a API Key em cada tipo de chamada
ConceitosLista completa de eventos suportados, interfaces de referência (Produto, Pedido, Promoção), sessões e contexto Segment
EndpointsReferência completa de cada rota: body, headers, exemplos e respostas
Códigos de erroTabela de erros HTTP e mensagens de retorno

Próximos passos