mocop
Browse · Docs · Guide · Analyze

BackResto API

API by BackResto · rest

BackResto Partner API: read-only access to a restaurant's HACCP records (deliveries, temperatures, cleaning, traceability) for partners the restaurant has authorised, plus the ingestion routes BackResto's own mobile app uses. Authentication: Authorization: Bearer brp_<prefix>.<secret> on partner routes. OAuth 2.0 clients can exchange the key at /oauth/token (client credentials); see /.well-known/oauth-authorization-server. Errors: every failure is an RFC 9457 problem details document (application/problem+json) with a stable type URI, the HTTP status and a requestId to quote to support. Rate limits: 300 requests per minute per partner key. Counted responses carry RateLimit-Policy and RateLimit headers (draft-ietf-httpapi-ratelimit-headers); a 429 carries Retry-After. Versioning and deprecation: every path is prefixed /v1 and the API is in closed beta, so an endpoint inside /v1 can still change shape or be withdrawn. Before one in use goes away it is marked…

Verification: observed. Source: crawl.

Capabilities (12)

  • Liveness probe
  • Readiness probe
  • Deployed release
  • Confirm a record attachment upload
  • Reserve a record attachment upload
  • Ingest a module record snapshot
  • Open a mobile session
  • List the restaurants your key reaches
  • List the record collections your key can read
  • List records of a collection
  • Get one record
  • List the attachments of a record
About · Contact · Privacy