Administración

Una API pequeña y honesta para tus propias herramientas

Acceso de lectura con clave a tu local, tu equipo y tus proveedores de pago, y webhooks de los cambios del local, del equipo y de la suscripción.

Actualizado

Qué obtienes

  • Claves por local

    Crea claves de API en los ajustes del local. Cada una pertenece a un solo local, se guarda cifrada con hash y puede tener fecha de caducidad.

  • Endpoints de lectura

    Consulta los datos del local, los miembros del equipo y los proveedores de pago activos con la versión 1 de la API.

  • Webhooks con registro

    Configura endpoints en el Manager, en Desarrolladores e integraciones, con registro de entregas y reintentos.

  • Historial de uso

    Cada llamada queda registrada con su clave, método, ruta, estado y tiempo de respuesta.

  • Límites según el plan

    Starter incluye 1 clave y 1 webhook, Growth 5 y 5, y Unlimited no tiene límite.

En esta página
  1. Qué hace
  2. Cómo funciona
  3. Qué cubren los webhooks
  4. Planes
  5. Si necesitas datos de pedidos
  6. Qué sustituye

Qué hace

DineHarbor tiene una API pública pequeña para los planes que la incluyen. Está pensada para herramientas que necesitan conocer el local con el que trabajan. Todavía no expone tus pedidos, tu carta ni tus pagos, y esta página lo dice con claridad para que decidas si te basta.

Cómo funciona

  1. En el Manager, abre los ajustes del local y crea una clave de API. Toda clave empieza por wsk_ y pertenece a un solo local.
  2. Elige sus permisos (scopes). Todos los endpoints disponibles hoy necesitan el permiso de lectura. Los demás existen para futuros endpoints y aún no se comprueban.
  3. Llama con la clave a los endpoints de la versión 1: tu local, sus miembros y sus proveedores de pago.
  4. Revisa el historial de uso en los ajustes para ver cada llamada, su estado y su hora.
  5. Para recibir webhooks, añade un endpoint en Ajustes, Desarrolladores e integraciones, y usa la guía de firma para verificar las entregas.

Qué cubren los webhooks

Los webhooks avisan de los cambios del local, de su equipo y de su suscripción: BranchUpdated, BranchMemberAdded, BranchMemberRemoved, BranchMemberRoleUpdated y SubscriptionUpdated. No avisan de pedidos, pagos ni cambios en la carta. Una entrega fallida se reintenta hasta tres veces en total con espera progresiva, y como todavía no hay una cabecera con identificador de entrega, tu gestor debe poder ejecutarse dos veces con el mismo contenido sin problema.

Planes

Starter incluye 1 clave de API y 1 webhook, Growth incluye 5 de cada uno, y Unlimited no tiene límite.

Si necesitas datos de pedidos

Los pedidos, los pagos y la carta están disponibles dentro de DineHarbor, en el Manager y sus informes, pero hoy no a través de la API pública. Cuéntanos en sales@dineharbor.com qué quieres conectar, porque eso orienta lo que se construye después. La documentación para desarrolladores está en inglés.

Qué sustituye

Todavía nada, y no lo pretende. Es un punto de partida para vigilar locales y equipos desde tus propias herramientas, y un lugar donde la API pueda crecer.

Preguntas y respuestas

¿Puedo leer o crear pedidos a través de la API?

Hoy no. La API lee tu local, sus miembros y sus proveedores de pago. Todavía no hay endpoint de pedidos, pagos ni carta.

¿Qué eventos envían los webhooks?

Actualizaciones del local, miembro del local añadido, eliminado y cambio de rol, y actualizaciones de la suscripción. Todavía no hay eventos de pedidos, pagos ni carta.

¿Qué pasa si mi endpoint falla?

Una respuesta que no sea 2xx se reintenta hasta tres veces en total, con espera progresiva. Todavía no hay una cabecera con identificador de entrega, así que haz tu gestor idempotente.

¿Dónde está la documentación?

En la documentación para desarrolladores en /docs, que está solo en inglés.

Funciones relacionadas

Para tu tipo de negocio

Comparativas

Sigue leyendo

Pon tu carta online hoy.

Haz una foto de tu carta, revisa los precios y empieza a recibir pedidos sin comisiones. Todas las funciones gratis durante 30 días, sin tarjeta y sin instalar nada.

Sin tarjeta · Cancela cuando quieras