Ir al contenido principal
Todas las coleccionesIntegraciones
API Pública: Para qué y cómo usarla
API Pública: Para qué y cómo usarla

En este artículo te explicaremos para qué podrías usar API Pública, dónde revisar documentación técnica y cómo usarla

Equipo de Producto avatar
Escrito por Equipo de Producto
Actualizado hace más de una semana

¿Para qué usar la API Pública de AgendaPro?

Las API's permiten desencadenar acciones en un sistema, dado un mandato externo (llamada). En el caso de AgendaPro tenemos distintas API's que pueden ser útiles para distintas acciones que puedes hacer "manualmente", todo bajo protocolo de seguridad. Por ejemplo, podrías realizar acciones sobre...

  • Citas: Listar, Ver detalle, Crear, Editar, Eliminar

  • Clientes: Listar, Ver detalle, Crear, Editar, Eliminar.

    • Adicionalmente: Ver fichas, Ver reservas, Ver pagos de un cliente en particular

  • Pagos: Listar, Ver detalle, Crear pagos de servicios, giftcards, productos

  • Locales: Listar, Ver detalle, Listar servicios del local, Listar profesionales del local

  • Servicios: Listar, Ver detalle, Listar profesionales, Listar horas disponibles

  • Profesionales: Listar profesionales, Ver detalle, Listar servicios del profesional

Ejemplos de uso:

  • Pagos: Tienes una página web externa en la que vendes giftcards, puedes generar el flujo de venta en la página web y enviar la info a AgendaPro para que quede registrado en tu caja de ventas y en giftcards.

  • Citas: Uno más complejo... quieres implementar un chatbot en tu empresa, lo puedes hacer con AgendaPro!

    • Podrás crear una cita con la API para que se vea reflejada en tu agenda, para eso antes debes saber:

      • Qué servicio, en qué sucursal, que fecha, hora de inicio y termino, datos básicos del cliente

¿Qué necesitas para usar la API?

  • Antes que todo, deberás tener contratado plan Pro que incluye 1.000 consultas/día + 0.004 USD por cada consulta una vez que se sobrepasa la cuota diaria

¿Cómo usar la API?

  • Aquí te dejamos un PDF con detalles técnicos, de las URL de cada API. Aquí podrás ver qué datos de entrada enviar y cómo serán las respuestas.

  • Para autentificarte, requerirás las credenciales que encontrarás en AgendaPro > Configuraciones > Integraciones y API Pública

  • Necesitarás los "id" de tu empresa para consultar, aquí 2 opciones:

    • Consultar a nuestro chat de soporte: "Hola! ¿Me enviarías tablas con mis datos para usarlos en llamadas a la API Pública? Necesito: company_id, locations_id - locations_name , services_id - services_name, provider_id - provider-name"

      • ⚠️Ojo!: Si creas nuevos locales, profesionales, servicios... deberás consultar los datos nuevos. Pero es la opción más simple y directa.

    • Usar las API para consultar datos de tu empresa, para eso al menos deberás tener tu company_id que puedes también consultarlo en soporte.

      • Si tu negocio es "muy dinámico", no tendrás que consultar cada vez al chat de soporte y podrás tener autonomía respecto de la consulta de información... pero puede requerir mayor esfuerzo técnico.

¿Ha quedado contestada tu pregunta?