1. Caminho de Acesso

Menu ▸ Integrações ▸ API EleveCRM
Base URL (exemplo): app.elevecrm.com.br/api/2.0

Endpoints disponíveis:

• POST /login → Autenticação via API Key
• GET /events/ → Lista as agendas cadastradas
• POST /events/create → Cria uma nova agenda
• GET /events/available_actions → Lista as ações válidas para criação

---

2. Permissões Necessárias

• Possuir API Key e API Secret gerados em: https://app.elevecrm.com.br/api_keys
• O usuário autenticado deve ter permissão de acesso ao módulo Agenda
  • Habilitação: Administração ▸ Perfis e Permissões ▸ Módulo “Agenda” ▸ Criar / Editar / Ver

---

3. Visão Geral

A API de Agendas (Events) do EleveCRM permite integrar sistemas externos com o módulo de compromissos, reuniões e atividades.

Com ela, é possível:

• Criar agendas automaticamente (ex.: reuniões agendadas em portais externos);
• Consultar agendas e ações realizadas no CRM;
• Padronizar o registro de tarefas, ligações e visitas;
• Sincronizar com ferramentas externas (VOIP, calendários, chatbots etc.).

---

4. Autenticação via API

Endpoint

POST /login

Requisição

{
  "api_key": "seu_api_key",
  "api_secret": "seu_api_secret"
}

Resposta

{
  "status": "success",
  "data": {
    "accessToken": "string",
    "refreshToken": "string",
    "expires_in": 3600,
    "type": "Bearer"
  }
}

Utilize o accessToken no header das chamadas seguintes:

Authorization: Bearer {accessToken}

---

5. Endpoints Disponíveis

Método	Endpoint	Descrição
GET	/events/	Lista todas as agendas cadastradas.
POST	/events/create	Cria uma nova agenda.
GET	/events/available_actions	Retorna as ações válidas para criação de agendas.

---

6. Exemplo de Retorno — GET /events/

{
  "status": "success",
  "total": 10,
  "data": [
    {
      "uuid": "string",
      "title": "string",
      "description": "string",
      "action": "string",
      "location": "string",
      "start_date": "2025-10-09T23:04:42.578Z",
      "end_date": "2025-10-09T23:04:42.578Z",
      "finished": true,
      "notified": true,
      "finished_at": "2025-10-09T23:04:42.578Z",
      "created_at": "2025-10-09T23:04:42.579Z",
      "updated_at": "2025-10-09T23:04:42.579Z",
      "finished_description": "string",
      "suspect": {
        "id": 0,
        "name": "string",
        "legal_name": "string",
        "type": "string",
        "document": "string"
      },
      "lead": {
        "id": 0,
        "name": "string",
        "email": "string"
      },
      "project": {
        "id": 0,
        "name": "string"
      },
      "deal": {
        "id": 0,
        "name": "string"
      },
      "user": {
        "id": 0,
        "name": "string",
        "email": "string"
      },
      "created_by": {
        "id": 0,
        "name": "string",
        "email": "string"
      }
    }
  ]
}

---

7. Exemplo de Criação — POST /events/create

Requisição

{
  "title": "Reunião de Apresentação EleveCRM",
  "description": "Agendada com o cliente Pro-Ativa para demonstração.",
  "start_date": "2025-10-10T14:00:00Z",
  "end_date": "2025-10-10T15:00:00Z",
  "action": "meeting",
  "location": "Teams",
  "deal_id": 12,
  "project_id": 3,
  "user": {
    "id": 1,
    "email": "[email protected]"
  },
  "lead": {
    "id": 25,
    "email": "[email protected]"
  },
  "suspect": {
    "id": 44,
    "type": "PJ",
    "document": "45.879.125/0001-20"
  }
}

Resposta esperada

{
  "status": "success",
  "data": {
    "uuid": "83e7e4c0-21c7-4b39-bc5d-1b845db2d52a",
    "message": "Agenda criada com sucesso"
  }
}

---

8. Boas Práticas / Recomendações

• 🔐 Sempre autentique via POST /login antes de outras chamadas.
• 📅 Utilize o formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ) para datas.
• ✅ Consulte /events/available_actions para confirmar ações válidas.
• 💾 Armazene o uuid do evento para atualizações ou logs futuros.
• ⚠️ Campos obrigatórios: title, action, start_date, end_date.

---

9. Limites e Restrições

• Apenas usuários com permissão “Criar Agendas” podem usar o POST /events/create.
• Tokens expiram conforme expires_in; reautentique periodicamente.

---

10. Uso no Dia a Dia

Essas APIs permitem integrar o módulo de Agendas do EleveCRM com sistemas externos:

• Criação automática de reuniões via formulários ou chatbots.
• Registro de calls VOIP ou reuniões online diretamente como atividades concluídas.
• Sincronização com Google Calendar ou Outlook via middlewares.
• Conexão com sistemas de BI, para medir produtividade e taxas de follow-up.

---

11. Erros Comuns / FAQ

Código	Motivo	Solução
401 Unauthorized	Token ausente ou expirado	Refaça a autenticação via /login
403 Forbidden	Falta de permissão no módulo Agenda	Ajuste o perfil de usuário
400 Bad Request	Campos obrigatórios ausentes	Revise o corpo da requisição
422 Invalid action	Tipo de ação não cadastrado	Consulte /events/available_actions

---

12. Itens Relacionados

• API de Login e Autenticação
• API de Leads
• API de Oportunidades
• Campos Customizados em Agendas

---