Documentación / Recursos Avançados
Recursos Avançados

Cómo Crear Servicios Programables Vía API en eAgenda

Crear Servicios

Resumen

La API de la plataforma eAgenda permite crear servicios de forma programática, posibilitando la automatización del registro de servicios con detalles como nombre, duración, precio y número máximo de clientes. Esta guía práctica detalla cómo configurar una solicitud HTTP POST al endpoint /api/v3/services/ y procesar la respuesta. Para más detalles, consulte la documentación oficial de la API de eAgenda.

Preparación del Entorno para Crear Servicios

Antes de comenzar, necesitará:

  • Clave de API: Acceda al panel de eAgenda para obtener su token Bearer.
  • Herramienta para solicitudes HTTP: Use cURL, Postman o bibliotecas como requests (Python) o axios (JavaScript).
  • Configuración del encabezado: La autenticación se realiza mediante Bearer Token. Configure el encabezado Authorization: Bearer y defina Content-Type: application/json.

Consejo: Consulte la documentación de autenticación de eAgenda para configurar el token correctamente.

Definición de los Datos para Crear Servicios

Para crear un servicio, envíe un objeto JSON en el cuerpo de la solicitud con los siguientes campos:

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

service_name (obligatorio)

  • Descripción: Nombre del servicio.
  • Restricciones: Mínimo de 1 carácter.
  • Impacto: Identifica el servicio en el sistema, mostrado a clientes y colaboradores.
  • Ejemplo: “Consulta Médica”

duration (obligatorio)

  • Descripción: Duración del servicio (formato libre, generalmente en minutos o HH:MM).
  • Impacto: Define el tiempo reservado para el servicio, influyendo en la programación.
  • Ejemplo: “00:30”

price (obligatorio)

  • Descripción: Precio del servicio.
  • Restricciones: Debe ser un número decimal (ej.: 100.50) o null. Máximo de 3 dígitos enteros y 2 dígitos decimales (patrón: ^-?\d{0,3}(?:\.\d{0,2})?$).
  • Impacto: Determina el costo del servicio para el cliente.
  • Ejemplo: 150.00

max_clients (obligatorio)

  • Descripción: Número máximo de clientes por horario.
  • Restricciones: Debe ser un número entero o null.
  • Impacto: Controla la capacidad de atención por horario.
  • Ejemplo: 5

account_slug (opcional)

  • Descripción: Slug de la cuenta o subcuenta asociada al servicio.
  • Restricciones: Mínimo de 1 carácter, patrón ^[-a-zA-Z0-9_]+$.
  • Cómo obtener el account_slug: Use el endpoint de listado de cuentas de eAgenda (consulte la documentación).
  • Impacto: Vincula el servicio a una cuenta específica, útil para organizaciones con múltiples cuentas.
  • Ejemplo: “minha-conta”

Nota: Los campos service_name, duration, price y max_clients son obligatorios. El campo account_slug es opcional, pero recomendado para vincular el servicio a una cuenta específica.

Envío de la Solicitud para Crear un Servicio

Para crear el servicio, envíe una solicitud HTTP POST al endpoint:

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

Configuración de la Solicitud

  • Método: POST
  • Encabezados:
    • accept: application/json
    • Authorization: Bearer
    • Content-Type: application/json
  • Cuerpo de la solicitud: JSON con los datos del servicio.

Ejemplo de Solicitud con 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"
}'

Ejemplo en 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())

Verificación de la Respuesta

La API devolverá una respuesta con el estado de la creación del servicio. Verifique los siguientes puntos:

  • Código de estado HTTP:
    • 201 Created: Servicio creado con éxito.
    • 400 Bad Request: Error en los datos enviados (verifique el JSON).
    • 401 Unauthorized: Token inválido o ausente.
  • Cuerpo de la respuesta: Contiene detalles del servicio creado, 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" }

El servicio quedará registrado en el sistema y estará disponible para programación de citas, respetando las configuraciones definidas. Puede usar otros endpoints de la API para gestionar o consultar servicios.

Conclusión

Con este tutorial, aprendió cómo crear servicios vía API de eAgenda, automatizando el registro de servicios con detalles como duración, precio y capacidad. Esta integración es ideal para gestionar ofertas de servicios de forma eficiente. Para más funcionalidades, como edición de servicios o integración con programación de citas, consulte la documentación completa de la API de eAgenda.

Contáctenos o Conozca Más

Estamos a su disposición para ayudarle. Acceda a nuestros canales oficiales:

📞 WhatsApp : Haga clic aquí para enviarnos un mensaje 🌐 Plataforma eAgenda : Conozca eAgenda 🏢 Nuestra Empresa : Mupi Systems – Soluciones Innovadoras 📧 Correo electrónico : contato@mupisystems.com.br 📚 Tutoriales y Documentación : Acceda a nuestras guías y tutoriales