Introdução
Bem-vindo à documentação da API Ecosys Auto. Integre gestão de veículos, clientes e automação automotiva em sua aplicação.
Documentação da API Ecosys Auto
Integre a gestão automotiva diretamente em suas aplicações. Acesse veículos, clientes, atividades e oportunidades de forma programática.
API RESTful
A API Ecosys Auto é RESTful, utiliza JSON para requests/responses e autenticação via API Key no header Authorization.
O que a API oferece
┌─────────────────────────────────────────────────────────────┐
│ Sua Aplicação │
└─────────────────────────┬───────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ API Ecosys Auto │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ • Autenticação por API Key │ │
│ │ • Gestão de Veículos (Inventory) │ │
│ │ • CRM de Clientes (PF/PJ) │ │
│ │ • Pipeline de Negócios (Deals) │ │
│ │ • Atividades e Tarefas │ │
│ │ • Registros Financeiros │ │
│ │ • Webhooks para eventos em tempo real │ │
│ └───────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘Por que usar a API Ecosys Auto?
| Benefício | Descrição |
|---|---|
| Integração Completa | Conecte seu sistema ao Ecosys Auto sem precisar acessar a interface web |
| Automação | Crie veículos, clientes e atividades automaticamente |
| Sincronização | Mantenha seus sistemas sincronizados via webhooks |
| Escalabilidade | API otimizada para alto volume de requisições |
| Segurança | Autenticação via API Key com escopo por time |
Primeiros Passos
Obtenha suas credenciais
Acesse Configurações → API Keys no painel do Ecosys Auto e gere suas chaves de API.
Cada chave está vinculada ao seu time e tem acesso completo aos recursos do time.
Configure a autenticação
Todas as requisições devem incluir o header Authorization com sua API Key.
Authorization: Bearer ea_live_sua_chave_aquiFaça sua primeira requisição
Teste a conexão listando seus veículos:
curl -X GET https://api.shopcar.com.br/v1/vehicles \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json"Base URL
Todas as requisições devem ser feitas para:
https://api.shopcar.com.br/v1Fluxo Típico de Integração
1. Criar Cliente → POST /v1/clients
↓
2. Criar Veículo → POST /v1/vehicles
↓
3. Adicionar Atividades → POST /v1/activities
↓
4. Acompanhar Eventos → Webhooks configuradosRecursos Disponíveis
Autenticação
Como autenticar suas requisições e gerenciar API Keys
Veículos
Criar, listar e gerenciar veículos do inventário
Clientes
Gerenciar clientes (Pessoa Física e Jurídica)
Atividades
Registrar e acompanhar atividades e tarefas
Negócios
Gerenciar pipeline de vendas
Financeiro
Controlar receitas, despesas e comissões
Webhooks
Receber notificações de eventos em tempo real
Conceitos Importantes
Times (Teams)
Todos os recursos pertencem a um time. Sua API Key está vinculada a um time específico e só pode acessar recursos desse time.
Veículos vs Negócios
- Veículo (Vehicle): Um veículo cadastrado no inventário (carro, moto, caminhão, etc.)
- Negócio (Deal): Uma oportunidade de venda no pipeline (potencial comprador interessado)
Clientes
Clientes podem ser:
- Pessoa Física (PF): CPF, RG, dados pessoais
- Pessoa Jurídica (PJ): CNPJ, razão social, dados empresariais
Fases e Status
- Veículos: Status configuráveis (disponível → reservado → em negociação → vendido)
- Negócios: Pipeline comercial (lead → qualificado → proposta → negociação → ganho/perdido)
Limites de Uso
| Plano | Requisições/Minuto | Requisições/Dia |
|---|---|---|
| Starter | 60 | 1.000 |
| Professional | 300 | 10.000 |
| Enterprise | 1.000 | Ilimitado |
Exceder os limites resultará em resposta 429 Too Many Requests. Implemente retry com backoff exponencial.
Suporte
Precisa de ajuda com sua integração?
- Email: suporte@shopcar.com.br
- Documentação: Você está aqui!