Skip to main content
These are the names used everywhere in the API, the dashboards and these docs. Each concept has exactly one name.

​
Partners and roles

  • Partner: a company that has a contract with AllRide. A partner is a provider, a consumer, or both, and is the owner of everything it creates. Every API key and every dashboard user acts for exactly one partner.
  • Partner Provider (“provider”): a partner that owns voucher sets and vouchers, for example a scooter or bike operator.
  • Partner Consumer (“consumer”): a partner that offers voucher sets to its own end customers and redeems them. You are a consumer. Consumers are the only partners AllRide bills.
  • End Customer: the person your app or landing page serves. End customers do not have accounts on the platform; you represent them as redemption entities if you want to.
  • User and Partner Membership: a person with a login, and the link that makes them a member of your partner. One person can be a member of several partners.
  • Group and Permission: permissions are capabilities with kebab-case names such as create-consumer-redemptions; groups carry permissions, and members get the union of their groups’ permissions and their own direct permissions (Members and groups).
  • API Access: a partner-level switch that AllRide activates before API keys work.
  • API Key: a secret credential of your partner whose scopes are a subset of the delegable permissions (API keys).

​
Core resources

Provider content
  • Voucher Set: a provider’s collection of vouchers that share content, terms, kind, link format and schedule.
  • Voucher Set Revision: an approved, unchangeable snapshot of a voucher set’s content. You only ever see the live revision; providers change content through a Change Request that AllRide approves before it reaches you.
  • Voucher: one redeemable item of a set, either a code or a link. The Voucher Kind (code or link) is declared per voucher set.
  • Redemption Type: single (a voucher can be redeemed once) or multiple (it can be redeemed up to Max Redemptions times; null means unlimited).
  • Validity Window: validFrom and validUntil of a voucher.
  • Availability: how a visible voucher set looks to you: upcoming, active or deactivation-scheduled.
Your side
  • Consumer Catalog: the providers and voucher sets AllRide makes available to you, with their live content (Catalog and toggles).
  • Catalog Toggle: your on/off switch per provider (Provider Toggle) and per voucher set (Voucher Set Toggle).
  • Price Terms and Price Acceptance: the price you pay per redemption of a voucher set, and a user’s recorded agreement to it. A set is redeemable only with an accepted price (Prices and price acceptance).
  • Redemption: the assignment of one voucher use to you (and optionally to a redemption entity), recorded in the ledger. Its Redemption Channel says how it was created: api, dashboard, redemption-link or import.
  • Void: marking a redemption as cancelled for reporting and limits. A void never returns the voucher to stock (Voiding redemptions).
  • Redemption Entity: your record of who or what redeems (a customer, a device, an employee), with an optional opaque refId and metadata (Redemption entities).
  • Redemption Link: a URL you create that lets an end customer redeem on an AllRide-hosted landing page (Redemption links).
  • Email OTP Gate: a Redemption Link option that asks the visitor to confirm an email address with a one-time code before redeeming (Email OTP links).
  • Landing Page: the page, in your Workspace Branding, that serves a Redemption Link, on AllRide’s host or your own Custom Domain (Landing pages and custom domains).
Integration
  • Webhook Endpoint: an HTTPS URL of yours that receives signed events; each attempt to send one is a Webhook Delivery (Webhooks).
  • Idempotency Key: the optional Idempotency-Key header that makes a POST safe to retry (Idempotency).
  • Audit Event: an append-only record of a change in your partner (Audit log).

​
Lifecycle at a glance

Providers create and schedule voucher sets; AllRide approves their content and decides which consumers may see them. From your side, a voucher set appears in your catalog, becomes redeemable, and eventually leaves it: