Portal do Desenvolvedor / Início Rápido
Portal do Desenvolvedor

Início Rápido

Este guia vai ajudá-lo a fazer sua primeira chamada à API do eAgenda em poucos minutos.

Visão geral

A API REST do eAgenda permite que você integre funcionalidades de agendamento online em qualquer sistema. Com ela, você pode:

  • Criar e gerenciar agendamentos programaticamente
  • Consultar horários disponíveis em tempo real
  • Gerenciar clientes, agendas e serviços
  • Receber notificações via webhooks quando eventos ocorrem

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

1. Obtenha suas credenciais

Para usar a API, você precisa de um token de acesso:

  1. Acesse o painel do eAgenda
  2. Vá em Configurações > Integrações > API
  3. Clique em Gerar Token de API
  4. Copie o token gerado — ele será exibido apenas uma vez

Importante: Guarde seu token em local seguro. Nunca o exponha em código-fonte público ou no frontend da sua aplicação.

2. Faça sua primeira requisição

Com o token em mãos, teste listando suas contas:

curl -X GET https://eagenda.com.br/api/v3/accounts/ \
  -H "Authorization: Basic SEU_TOKEN_BASE64"

A autenticação usa HTTP Basic Auth. O token deve ser codificado em Base64 no formato usuario:senha.

Resposta de exemplo

{
  "count": 1,
  "results": [
    {
      "account_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Minha Empresa",
      "slug": "minha-empresa",
      "is_active": true
    }
  ]
}

3. Entenda a estrutura da API

Recursos principais

RecursoEndpointDescrição
Contas/api/v3/accounts/Gerenciar contas e sub-contas
Agendas/api/v3/calendars/Gerenciar agendas (calendários)
Serviços/api/v3/services/Gerenciar serviços oferecidos
Horários/api/v3/available-date-times/Consultar disponibilidade
Agendamentos/api/v3/appointments/Criar e gerenciar agendamentos
Pessoas/api/v3/people/Gerenciar clientes/pessoas
Tags/api/v3/tags/Classificar agendamentos
Webhooks/api/v3/webhooks/Receber notificações de eventos
Usuários/api/v3/users/Gerenciar usuários da conta

Paginação

Todos os endpoints de listagem retornam resultados paginados:

{
  "count": 150,
  "next": "https://eagenda.com.br/api/v3/appointments/?page=2",
  "previous": null,
  "results": [...]
}

Use os parâmetros page e page_size para navegar entre as páginas.

Formato de resposta

  • Todas as respostas são em JSON
  • Datas seguem o formato ISO 8601 (2026-06-04T14:30:00-03:00)
  • Identificadores únicos usam o formato UUID (a1b2c3d4-e5f6-7890-abcd-ef1234567890)

4. Próximos passos

  • Autenticação — Entenda os métodos de autenticação e como proteger suas credenciais
  • Criar um agendamento — Tutorial passo a passo para criar seu primeiro agendamento via API
  • Listar horários disponíveis — Como consultar a disponibilidade de uma agenda
  • Referência interativa — Teste os endpoints diretamente no navegador na página de Referência da API

Repositório de exemplos

Disponibilizamos um repositório no GitHub com exemplos de integração prontos para uso:

GitHub: mupisystems/eagenda-integracao