Gestion
Une petite API honnête pour vos propres outils
Un accès en lecture par clé à votre établissement, votre équipe et vos moyens de paiement, et des webhooks pour les changements de l'établissement, de l'équipe et de l'abonnement.
Mis à jour
Ce que vous obtenez
Des clés par établissement
Créez des clés d'API dans les réglages de l'établissement. Chacune appartient à un seul établissement, est stockée hachée et peut avoir une date d'expiration.
Des points d'accès en lecture
Lisez les informations de votre établissement, les membres de l'équipe et les moyens de paiement actifs via la version 1 de l'API.
Des webhooks avec journal
Configurez vos points de réception dans Manager, sous Développeurs et intégrations, avec un journal des envois et une relance.
Historique d'utilisation
Chaque appel est enregistré avec sa clé, sa méthode, son chemin, son statut et son temps de réponse.
Des limites selon la formule
Starter comprend 1 clé et 1 webhook, Growth 5 et 5, et Unlimited n'a aucune limite.
Sur cette page
Ce que fait l'API
DineHarbor propose une petite API publique pour les formules qui l'incluent. Elle s'adresse aux outils qui ont besoin de connaître l'établissement avec lequel ils travaillent. Elle n'expose pas encore vos commandes, votre carte ni vos paiements, et cette page le dit clairement pour que vous puissiez juger si cela vous suffit.
Son fonctionnement
- Dans Manager, ouvrez les réglages de l'établissement et créez une clé d'API. Chaque clé commence par wsk_ et appartient à un seul établissement.
- Choisissez ses autorisations. Tous les points d'accès disponibles aujourd'hui demandent l'autorisation de lecture. Les autres existent pour de futurs points d'accès et ne sont pas encore vérifiées.
- Appelez les points d'accès de la version 1 avec la clé : votre établissement, ses membres et ses moyens de paiement.
- Consultez l'historique d'utilisation dans les réglages pour voir chaque appel, son statut et son heure.
- Pour recevoir des webhooks, ajoutez un point de réception sous Réglages, Développeurs et intégrations, puis suivez le guide de signature pour vérifier les envois.
Ce que couvrent les webhooks
Les webhooks signalent les changements de l'établissement, de son équipe et de son abonnement : BranchUpdated, BranchMemberAdded, BranchMemberRemoved, BranchMemberRoleUpdated et SubscriptionUpdated. Ils ne signalent ni les commandes, ni les paiements, ni les modifications de la carte. Un envoi échoué est renvoyé jusqu'à trois fois au total, avec un délai croissant, et comme il n'y a pas encore d'en-tête d'identifiant d'envoi, votre traitement doit pouvoir s'exécuter deux fois avec le même contenu sans danger.
Les formules
Starter comprend 1 clé d'API et 1 webhook, Growth en comprend 5 de chaque, et Unlimited n'a aucune limite.
Si vous avez besoin des données de commandes
Les commandes, les paiements et la carte sont disponibles dans DineHarbor, dans Manager et ses rapports, mais pas via l'API publique aujourd'hui. Dites-nous ce que vous voulez connecter à sales@dineharbor.com, car cela oriente ce que nous construirons ensuite. La documentation développeur est en anglais.
Ce que cette fonction remplace
Rien pour l'instant, et elle ne cherche pas à le faire. C'est un point de départ pour surveiller vos établissements et vos équipes depuis vos propres outils, et un espace où l'API pourra grandir.
Questions et réponses
Puis-je lire ou créer des commandes via l'API ?
Pas aujourd'hui. L'API lit votre établissement, ses membres et ses moyens de paiement. Il n'existe pas encore de point d'accès pour les commandes, les paiements ou la carte.
Quels événements les webhooks envoient-ils ?
Les mises à jour de l'établissement, l'ajout, le retrait et le changement de rôle d'un membre, et les mises à jour de l'abonnement. Il n'y a pas encore d'événements pour les commandes, les paiements ou la carte.
Que se passe-t-il si mon point de réception échoue ?
Une réponse autre que 2xx est renvoyée jusqu'à trois fois au total, avec un délai croissant. Il n'y a pas encore d'en-tête d'identifiant d'envoi, rendez donc votre traitement idempotent.
Où trouver la documentation ?
Dans la documentation développeur, à l'adresse /docs, qui n'existe qu'en anglais.
Fonctionnalités liées
- Logiciel pour restaurants multi-établissementsGérez plusieurs restaurants depuis un seul compte DineHarbor, passez d'un établissement à l'autre d'un toucher, avec des formules pour 1, 5 ou illimité.
- Rapports de ventes et de performance de restaurantComparez vos ventes à la période précédente, voyez meilleurs plats, heures de pointe, temps de préparation, annulations, pourboires et tickets Z.
- Personnel, rôles et services de caisseAjoutez du personnel en nombre illimité avec rôles, connexion par code PIN et autorisations par appareil, et gérez les services de caisse avec clôture.