Portal do Desenvolvedor / Changelog e Versionamento
Portal do Desenvolvedor

Changelog e Versionamento

Acompanhe as mudanças e atualizações da API do eAgenda. Seguimos o versionamento semântico para garantir compatibilidade e previsibilidade.

Versionamento

A API usa versionamento na URL:

https://eagenda.com.br/api/v3/

A versão atual é v3. Mudanças que quebram compatibilidade resultam em uma nova versão major (ex: v4). Melhorias e correções são feitas dentro da versão atual sem quebrar integrações existentes.

Política de compatibilidade

Dentro de uma mesma versão, garantimos:

  • Endpoints existentes continuam funcionando
  • Campos existentes nas respostas não são removidos
  • Novos campos podem ser adicionados às respostas (sua integração deve ignorar campos desconhecidos)
  • Novos endpoints podem ser adicionados
  • Novos parâmetros opcionais podem ser adicionados

O que pode mudar sem aviso

  • Ordem dos campos nas respostas JSON
  • Adição de novos campos opcionais
  • Adição de novos valores em enums (ex: novos status)
  • Mensagens de erro (o código HTTP permanece estável)

Boas práticas para integrações duráveis

  1. Ignore campos desconhecidos — Não quebre se a API retornar campos novos
  2. Não dependa da ordem dos campos — Parse o JSON por nome de campo, não por posição
  3. Trate enums com default — Se um status desconhecido aparecer, trate com um fallback
  4. Monitore este changelog — Assine as atualizações para ficar informado sobre mudanças

Histórico de mudanças

Junho 2026

  • Publicação do Portal do Desenvolvedor com documentação completa
  • Adicionados exemplos de código em Python, JavaScript, PHP e C#

Recursos da API v3

A versão 3 da API inclui os seguintes recursos:

  • Contas — CRUD completo de contas e sub-contas
  • Agendas — Gerenciamento de calendários com filtros por modo de agendamento
  • Serviços — Gerenciamento de serviços com duração e preço
  • Horários disponíveis — Consulta de disponibilidade com suporte a múltiplos serviços
  • Horários aleatórios — Endpoint para sugerir horários disponíveis aleatoriamente
  • Dias disponíveis — Consulta de dias com disponibilidade no período
  • Agendamentos — CRUD completo com reagendamento e 11 status diferentes
  • Pessoas — Gerenciamento de clientes com busca por CPF, e-mail, telefone ou ID externo
  • Tags — Classificação de agendamentos
  • Listas de acesso — Controle de acesso por lista de clientes
  • Formulários — Formulários personalizados vinculados às agendas
  • Webhooks — Notificações em tempo real via HTTP callbacks
  • Usuários — Gerenciamento de usuários e permissões
  • Schema OpenAPI — Especificação completa disponível em /api/v3/schema/