Back office
A small, honest API for your own tools
Keyed read access to your branch, team and payment providers, and webhooks for changes to the branch, the team and the subscription.
Updated
What you get
Keys per branch
Create API keys in the branch settings. Each belongs to one branch, is stored hashed and can carry an expiry.
Read endpoints
Read your branch details, team members and active payment providers over version 1 of the API.
Webhooks with a log
Set up endpoints in the Manager under Developers and integrations, with a delivery log and retry.
Usage history
Every call is logged against its key with method, path, status and response time.
Limits by plan
Starter has 1 key and 1 webhook, Growth 5 and 5, and Unlimited has no limit.
What it does
DineHarbor has a small public API for the plans that include it. It is meant for tools that need to know about the branch they work with. It does not yet expose your orders, menu or payments, and this page says so plainly so you can decide whether it is enough.
How it works
- In the Manager, open the branch settings and create an API key. Every key starts with wsk_ and belongs to one branch.
- Choose its scopes. Every endpoint available today needs the read scope. The other scopes exist for future endpoints and are not yet checked.
- Call the version 1 endpoints with the key: your branch, its members, and its payment providers.
- Check the usage history in settings to see each call, its status and time.
- To receive webhooks, add an endpoint under Settings, Developers and integrations, and use the signature guide to verify deliveries.
What webhooks cover
Webhooks announce changes to the branch, to its team and to its subscription: BranchUpdated, BranchMemberAdded, BranchMemberRemoved, BranchMemberRoleUpdated and SubscriptionUpdated. They do not announce orders, payments or menu changes. A failed delivery is retried up to three times in total with backoff, and because there is no delivery id header yet, your handler should be safe to run twice with the same content.
Plans
Starter includes 1 API key and 1 webhook, Growth includes 5 of each, and Unlimited has no limit.
If you need order data
Orders, payments and the menu are available inside DineHarbor, in the Manager and its reports, but not through the public API today. Tell us at sales@dineharbor.com what you want to connect, since that shapes what is built next. The developer documentation is in English.
What it replaces
Nothing yet, and it does not try to. It is a starting point for monitoring branches and teams from your own tools, and a place for the API to grow.
Questions and answers
Can I read or create orders through the API?
Not today. The API reads your branch, its members and its payment providers. There is no order, payment or menu endpoint yet.
Which events do webhooks send?
Branch updates, branch member added, removed and role updated, and subscription updates. There are no order, payment or menu events yet.
What happens if my endpoint fails?
A non 2xx answer is retried up to three times in total with backoff. There is no delivery id header yet, so make your handler idempotent.
Where is the documentation?
In the developer docs at /docs, which are in English only.
Related features
- Multi Location Restaurant SoftwareRun several restaurants from one DineHarbor account, switch between locations in a tap, and add locations as you grow, with plans for 1, 5 or unlimited.
- Restaurant Sales and Performance ReportsSee sales against the last period, top dishes, the busiest hours, kitchen prep times, voids by employee, tips and Z-reports, for any day, week or month.
- Restaurant Staff, Roles and Till ShiftsAdd unlimited staff with roles, PIN sign-in and device permissions, and run till shifts with cash up, so each person only sees and does their own job.