Introduction

The AllRide Voucher Platform connects Partner Providers, who own vouchers (ride credits, unlock codes, deep links), with Partner Consumers, who offer them to their customers. This site documents the API for providers: everything you can do in the provider dashboard, you can also do through the API.

​

What you can build

• Inventory sync: push codes or links from your systems into voucher sets with the batch API or large CSV and XLSX uploads, and revoke vouchers that must not be used any more.
• Catalog management: create voucher sets, propose content through change requests that AllRide approves, and activate or schedule them.
• Monitoring: read stock, receive threshold alerts, and follow redemptions and statistics without ever seeing who redeemed.
• Event-driven integrations: receive signed webhooks for approvals, lifecycle changes, uploads and redemptions.
• Workspace automation: manage webhook endpoints, read the audit log.

​

Environments

The two environments are fully separate: partner accounts, keys, webhooks and data do not carry over. The API reference and its playground use the sandbox. See Sandbox and production.

​

How the API is organised

The Provider API has two surfaces, both under the same host: The provider dashboard calls exactly these operations, with the signed-in user’s token instead of an API key. A few security operations (creating API keys, editing members, the IP allowlist) are dashboard-only; their reference pages say so. Every request is JSON over HTTPS, authenticated with Authorization: Bearer <API key>. Responses use the envelope {"data": …}; errors use {"errors": [{"message", "statusCode", "errorCode"}]}. Read Requests and responses and Errors before you build.

​

Get help

• Contact AllRide API support through Support in the top navigation or your AllRide account manager. Include the X-Request-Id of the response (and the requestId of a 5xx error), the operation and the time.
• API changes, network changes and sandbox resets are announced by email to your technical contact (contacts.technicalEmail).
• Your account manager at AllRide activates API access and answers commercial questions.

​

Using these docs with AI coding agents

• Every page has a copy and view menu that exports it as Markdown for your agent.
• The OpenAPI 3.1 document behind the API reference is the source of truth for paths, schemas and error codes. Download it as provider.v1.json (always the version published on this site) and point your agent or a code generator at it; there are no official SDKs in v1.
• Tell your agent three rules: send an Idempotency-Key on every POST, parse integer ids and counters as 64-bit unsigned values (they can exceed 2^53, so use a BigInt-safe JSON parser in JavaScript), and branch on errorCode, never on message.
• Never paste a live API key into an agent session; use a vk_test_ key in the sandbox.

​

Related

• Quickstart
• Concepts
• Authentication