Authentication

DineHarbor uses a single kind of bearer token: a branch API key. Send it in the Authorization header.

bash$
curl https://dineharbor.com/api/v1/branch \
  -H "Authorization: Bearer wsk_••••••••••••••••••••••••••••••••••••••••"

Keys

Every key starts with wsk_, is created from your branch's Settings → API keys page, and belongs to one branch. Keys are stored hashed, can carry an optional expiry date, and can be revoked at any time. There is no separate sandbox or publishable key type — one key type, one branch each.

Scopes

A key is created with one or more scopes: read, write, webhooks, team:read, billing:read.

FieldTypeDescription
GET /v1/branchreadYour branch's details.
GET /v1/membersreadTeam members of your branch.
GET /v1/payment-providersreadActive payment providers on your branch.
GET /v1/payment-providers/:idreadA single payment provider.

Every endpoint above requires the read scope. The other scopes exist on a key so you can prepare for future endpoints, but nothing checks them yet.

Errors

A missing, invalid or expired key returns 401. A key without the required scope returns 403. See the Errors page for the response shape.

Usage

Every call is logged against the key that made it — method, path, status code and response time. You can see this history from Settings → API usage.