> ## Documentation Index
> Fetch the complete documentation index at: https://docs-provider.voucher.allride.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Build on the AllRide Vouchers Provider API.

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](https://docs-provider.voucher.allride.io/provider/vouchers-and-uploads.md#batch-api) or large [CSV and XLSX uploads](https://docs-provider.voucher.allride.io/provider/vouchers-and-uploads.md#upload-a-file), and revoke vouchers that must not be used any more.
* **Catalog management**: create [voucher sets](https://docs-provider.voucher.allride.io/provider/voucher-sets.md), propose content through [change requests](https://docs-provider.voucher.allride.io/provider/change-requests.md) that AllRide approves, and [activate or schedule](https://docs-provider.voucher.allride.io/provider/activation-and-scheduling.md) them.
* **Monitoring**: read [stock](https://docs-provider.voucher.allride.io/provider/stock-and-alerts.md), receive threshold alerts, and follow [redemptions and statistics](https://docs-provider.voucher.allride.io/provider/redemptions-and-analytics.md) without ever seeing who redeemed.
* **Event-driven integrations**: receive signed [webhooks](https://docs-provider.voucher.allride.io/webhooks/overview.md) for approvals, lifecycle changes, uploads and redemptions.
* **Workspace automation**: manage webhook endpoints, read the [audit log](https://docs-provider.voucher.allride.io/workspace/audit-log.md).

## Environments

| | Sandbox | Production |
| - | - | - |
| API base URL | `https://api.voucher-staging.allride.io` | `https://api.voucher.allride.io` |
| Developer dashboard | `https://provider-developers.voucher-staging.allride.io` | `https://provider-developers.voucher.allride.io` |
| API key prefix | `vk_test_` | `vk_live_` |
| Data | Test data only, never real voucher codes | Real |

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](https://docs-provider.voucher.allride.io/guides/environments.md).

## How the API is organised

The Provider API has two surfaces, both under the same host:

| Surface | Path | What it covers |
| - | - | - |
| Provider API | `/provider/v1` | Provider profile, listing branding, categories, voucher sets, change requests, vouchers, uploads, stock alerts, redemptions, analytics |
| Workspace API | `/partner/v1` | Your partner record and settings, members and groups, API keys, webhooks, IP allowlist, workspace branding, single sign-on, audit log |

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](https://docs-provider.voucher.allride.io/guides/requests-and-responses.md) and [Errors](https://docs-provider.voucher.allride.io/errors.md) 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](https://docs-provider.voucher.allride.io/api-reference/provider-voucher-sets-create.md) is the source of truth for paths, schemas and error codes. Download it as [`provider.v1.json`](https://github.com/AllRide-Mobility/AllRideVoucherPartnerProviderAPIDocs/releases/latest/download/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](https://docs-provider.voucher.allride.io/quickstart.md)
* [Concepts](https://docs-provider.voucher.allride.io/guides/concepts.md)
* [Authentication](https://docs-provider.voucher.allride.io/guides/authentication.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.