Skip to main content
The AllRide Voucher Platform connects Partner Providers (for example scooter, bike or car-sharing operators) that publish vouchers with Partner Consumers that offer those vouchers to their own end customers. As a Partner Consumer you use the Consumer API to read the voucher sets AllRide makes available to you, redeem vouchers for your customers, hand out Redemption Links, and follow everything through webhooks, analytics and billing. Everything the consumer dashboard does goes through this same API. If you can do it in the dashboard, you can automate it, with a small set of security and billing actions reserved for signed-in dashboard users.

​
What you can build

  • Redeem in your own app: redeem a voucher with one POST /consumer/v1/redemptions call and show the issued code or link to your customer (Redeeming vouchers).
  • Share Redemption Links: send a link by email, SMS or in your app; the customer picks a voucher on a landing page in your branding (Redemption links).
  • Curate your catalog: turn providers and voucher sets on or off, order and feature them, and keep your own references (Catalog and toggles).
  • Gate links by email: let customers prove their email address with a one-time code sent through your own SMTP server (Email OTP links).
  • Track and reconcile: read redemption statistics, page through lists and receive webhooks for every redemption (Analytics).
  • Automate billing: fetch invoices, Stornorechnungen and e-invoices into your ERP with an API key (Billing).

​
Environments

You build and test in the sandbox and go live in production. They are separate environments with separate partner accounts, API keys, webhook endpoints and data. The addresses of both environments are listed on Network and IP addresses. Sandbox and production explains the differences.

​
How the API is organised

The Consumer API has two surfaces, both under the same host and both documented on this site:
  • Consumer API (/consumer/v1): your catalog and catalog settings, redemptions, redemption entities, Redemption Links, email OTP settings, analytics, billing and pricing.
  • Workspace API (/partner/v1): everything about your partner workspace that providers and consumers share: partner record and settings, members and groups, API keys, webhook endpoints and delivery logs, IP allowlist, custom domains, branding, single sign-on and audit log. The SMTP configuration and email templates for the Email OTP Gate also live here.
The version is part of the path (/consumer/v1), and every request:
  • authenticates with Authorization: Bearer <API key> (Authentication);
  • sends and receives JSON; single resources come as {"data": {…}} and lists as a page envelope (Requests and responses);
  • may carry an Idempotency-Key on POST so that retries are safe (Idempotency);
  • answers errors as {"errors": [{"message", "statusCode", "errorCode"}]} with a stable errorCode (Errors).
The API reference lists every operation with its required permissions and whether API keys may call it. The webhook event catalog lists every event you can subscribe to.

​
Get help

  • Start with the quickstart: it takes you from an API key to a redemption and a verified webhook in the sandbox.
  • Look up any errorCode in the error catalog; it says what happened and what to do.
  • New features, deprecations and network changes are announced by email to your technical contact (contacts.technicalEmail).
  • For anything else, contact your AllRide account manager or AllRide through the Support link at the top of this site. Include the X-Request-Id response header (or the requestId of a 5xx error), the time of the request and the operation you called. Never send API keys, webhook secrets or customer data.

​
Using these docs with AI coding agents

These docs are available in machine-readable form, so you can give an AI coding assistant accurate context:
  • /llms-full.txt contains every page of this site as one Markdown file; /llms.txt is the index.
  • Every page is also available as Markdown: add .md to its URL, or use the page menu to copy it or open it in an assistant.
  • Download the OpenAPI 3.1 document of the Consumer and Workspace API as consumer.v1.json. This link always serves the version published on this site.
AllRide publishes no official SDKs. Generate a client from the OpenAPI document with any OpenAPI 3.1 generator. Ids and some counters are unsigned 64-bit integers (format: uint64) that can exceed 2^53, so in JavaScript parse responses with a BigInt-safe JSON parser.