Documentação / Recursos Avançados
Recursos Avançados

Como Criar Serviços Agendáveis Via API no eAgenda

Criar Serviços

Resumo

A API da plataforma eAgenda permite criar serviços de forma programática, possibilitando a automação do cadastro de serviços com detalhes como nome, duração, preço e número máximo de clientes. Este guia prático detalha como configurar uma requisição HTTP POST para o endpoint /api/v3/services/ e processar a resposta. Para mais detalhes, consulte a documentação oficial da API da eAgenda.

Preparação do Ambiente Para Criar Serviços

Antes de começar, você precisará:

  • Chave de API: Acesse o painel da eAgenda para obter seu token Bearer.
  • Ferramenta para requisições HTTP: Use cURL, Postman ou bibliotecas como requests (Python) ou axios (JavaScript).
  • Configuração do cabeçalho: A autenticação é feita via Bearer Token. Configure o cabeçalho Authorization: Bearer e defina Content-Type: application/json.

Dica: Consulte a documentação de autenticação da eAgenda para configurar o token corretamente.

Definição dos Dados para Criar Serviços

Para criar um serviço, envie um objeto JSON no corpo da requisição com os seguintes campos:

{
  "service_name": "string",
  "duration": "string",
  "price": "decimal",
  "max_clients": integer,
  "account_slug": "string"
}

service_name (obrigatório)

  • Descrição: Nome do serviço.
  • Restrições: Mínimo de 1 caractere.
  • Impacto: Identifica o serviço no sistema, exibido para clientes e colaboradores.
  • Exemplo: “Consulta Médica”

duration (obrigatório)

  • Descrição: Duração do serviço (formato livre, geralmente em minutos ou HH:MM).
  • Impacto: Define o tempo reservado para o serviço, influenciando o agendamento.
  • Exemplo: “00:30”

price (obrigatório)

  • Descrição: Preço do serviço.
  • Restrições: Deve ser um número decimal (ex.: 100.50) ou null. Máximo de 3 dígitos inteiros e 2 dígitos decimais (padrão: ^-?\d{0,3}(?:\.\d{0,2})?$).
  • Impacto: Determina o custo do serviço para o cliente.
  • Exemplo: 150.00

max_clients (obrigatório)

  • Descrição: Número máximo de clientes por horário.
  • Restrições: Deve ser um número inteiro ou null.
  • Impacto: Controla a capacidade de atendimento por horário.
  • Exemplo: 5

account_slug (opcional)

  • Descrição: Slug da conta ou subconta associada ao serviço.
  • Restrições: Mínimo de 1 caractere, padrão ^[-a-zA-Z0-9_]+$.
  • Como obter o account_slug: Use o endpoint de listagem de contas da eAgenda (consulte a documentação).
  • Impacto: Vincula o serviço a uma conta específica, útil para organizações com múltiplas contas.
  • Exemplo: “minha-conta”

Nota: Os campos service_name, duration, price e max_clients são obrigatórios. O campo account_slug é opcional, mas recomendado para vincular o serviço a uma conta específica.

Envio da Requisição para Criar Serviço

Para criar o serviço, envie uma requisição HTTP POST para o endpoint:

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

Configuração da Requisição

  • Método: POST
  • Cabeçalhos:
    • accept: application/json
    • Authorization: Bearer
    • Content-Type: application/json
  • Corpo da requisição: JSON com os dados do serviço.

Exemplo de Requisição com cURL

curl -X POST https://eagenda.com.br/api/v3/services/ \
-H "accept: application/json" \
-H "Authorization: Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999" \
-H "Content-Type: application/json" \
-d '{
  "service_name": "Consulta Médica",
  "duration": "00:30",
  "price": 150.00,
  "max_clients": 5,
  "account_slug": "minha-conta"
}'

Exemplo em Python (usando requests)

import requests

url = "https://eagenda.com.br/api/v3/services/"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer ba08ab41bd58e9b9f82b4d2788b3cd9999ee9999",
    "Content-Type": "application/json"
}
data = {
    "service_name": "Consulta Médica",
    "duration": "00:30",
    "price": 150.00,
    "max_clients": 5,
    "account_slug": "minha-conta"
}

response = requests.post(url, json=data, headers=headers)
print(response.status_code)
print(response.json())

Verificação da Resposta

A API retornará uma resposta com o status da criação do serviço. Verifique os seguintes pontos:

  • Código de status HTTP:
    • 201 Created: Serviço criado com sucesso.
    • 400 Bad Request: Erro nos dados enviados (verifique o JSON).
    • 401 Unauthorized: Token inválido ou ausente.
  • Corpo da resposta: Contém detalhes do serviço criado, como:{ "service_key": "19730681-2aa0-4000-84b6-2bc54b4ace01", "service_name": "Consulta Médica", "duration": "00:30", "price": "150.00", "max_clients": 5, "account_slug": "minha-conta" }

O serviço será registrado no sistema e estará disponível para agendamentos, respeitando as configurações definidas. Você pode usar outros endpoints da API para gerenciar ou consultar serviços.

Conclusão

Com este tutorial, você aprendeu como criar serviços via API da eAgenda, automatizando o cadastro de serviços com detalhes como duração, preço e capacidade. Essa integração é ideal para gerenciar ofertas de serviços de forma eficiente. Para mais funcionalidades, como edição de serviços ou integração com agendamentos, consulte a documentação completa da API da eAgenda.

Entre em Contato ou Saiba Mais

Estamos à disposição para ajudar! Acesse nossos canais oficiais:

📞 WhatsApp : Clique aqui para nos enviar uma mensagem
🌐 Plataforma eAgenda : Conheça o eAgenda
🏢 Nossa Empresa : Mupi Systems – Soluções Inovadoras
📧 E-mail : contato@mupisystems.com.br
📚 Tutoriais e Documentação : Acesse nossos guias e tutoriais