Skip to main content

TapStellar for developers

The TapStellar public API gives you read access to your reviews, listings, citations, and NFC plates, lets you re-point a plate's destination, and pushes HMAC-signed webhooks when things change. It ships with the Local SEO Pack add-on.

OpenAPI 3.1.0 spec

Everything below is described machine-readably in our OpenAPI 3.1.0 document (API version 1.0.0). Import it into Postman, Insomnia, or any OpenAPI client generator:

/api/v1/openapi.json

Authentication

Every /api/v1/* endpoint except the public widget requires a Bearer API key. Create one from the dashboard; the token is shown once and stored only as a sha256 hash.

Authorization: Bearer lh_pk_<your-token>

Endpoints

Read

  • GET /api/v1/reviews: Synced Google reviews, newest first.
  • GET /api/v1/listings: Business-listing sync state per platform.
  • GET /api/v1/citations: Directory citation submissions.
  • GET /api/v1/plates: NFC plates (list, or one with ?id).

List endpoints paginate with ?limit= (1–200, default 50) and ?cursor= (pass the previous page's nextCursor). Results are newest-first.

Write

  • POST /api/v1/plates/{id}/repoint: Re-point a plate's destination URL; fires plate.repointed.

Public (no auth)

  • GET /api/v1/widget/{slug}: Public review-widget feed, no auth.

Webhooks

Subscribe per-account from the dashboard. Each endpoint has its own HMAC-SHA256 signing secret and event subscriptions. The signature is sent in the X-TapStellar-Signature header in Stripe-compatible t=<unix>,v1=<hex> format; verify with HMAC-SHA256(secret, "{t}.{rawBody}") and reject any timestamp more than five minutes off your clock.

Documented events:

  • review.posted
  • review.replied
  • listings.synced
  • listings.drift_detected
  • citations.submitted
  • citations.verified
  • citations.failed
  • gbp_post.published
  • plate.repointed
  • plate.link_health_failed
  • review_request.queued
  • review_request.sent
  • review_request.skipped

Zapier

A Zapier integration scaffold lives in the repo at docs/integrations/zapier/. Triggers map to the webhook events above; actions cover plate re-point and campaign creation; authentication is your lh_pk_ Bearer key. It's a boilerplate you can zapier push from, not yet a published public app.

Rate limits & versioning

Bearer endpoints allow 600 requests/minute per API key; the public widget shares a 120/min per-IP budget. Over the limit returns 429. This is v1; breaking changes ship as v2 with a six-month overlap. Additive fields land in v1 without notice, so ignore unknown fields.

Questions: developers@tapstellar.com. See also the full reference in our privacy policy.