Skip to main content

​
Environments at a glance

The sandbox is a separate environment, not a test mode of production. Partner accounts, members, API keys, webhook endpoints, voucher sets and redemptions exist in one environment only. There is no “test mode” flag in production. A key works only in its own environment: a vk_test_ key sent to production, or a vk_live_ key sent to the sandbox, gets 401 api-key-invalid.

​
Getting sandbox access

  1. Send your AllRide account manager (or AllRide through the Support link at the top of this site) your company name and the email address of your first user. AllRide creates your sandbox partner and invites that user. Sign in to the sandbox developer dashboard.
  2. Request API access on the API access page (POST /partner/v1/api-access:request, dashboard only). AllRide activates it; until then every API key call gets 403 api-access-inactive.
  3. Create an API key under API keys and call GET /partner/v1/principal to check it.
GET /partner/v1/api-access shows the state: not-requested, requested, active or suspended, with the decision reason when AllRide declined or suspended access.

​
Test data

The sandbox contains seeded data so you can test end to end without help from AllRide:
  • The consumer sandbox-transit can see your voucher sets: when your partner is activated in the sandbox, AllRide’s automation grants it access and records the consumer-side approvals it needs.
  • Every 5 minutes sandbox-transit redeems one voucher of every active set that it has not redeemed from yet. This produces real redemption-created webhooks, stock changes and statistics.
  • Change requests whose automated content checks pass are approved automatically; the others wait for an AllRide reviewer as in production.
  • The provider sandbox-scooters shows sample sets (a code set with an unlimited voucher, a link set, a depleted set and an upcoming set). You can only read what consumers would see; it is not your data.
Never upload real voucher codes or personal data to the sandbox.

​
Differences from production

Everything else is identical: endpoints, schemas, validation, limits, error codes and webhook signatures.

​
Moving to production

  1. Request API access in the production developer dashboard; AllRide activates it after your onboarding.
  2. Create production keys (vk_live_) with the minimum scopes; store them in a secret manager.
  3. Re-create webhook endpoints and IP allowlist entries in production; nothing is copied.
  4. Re-create your voucher sets and submit their change requests; AllRide reviews them.
  5. Work through the going-live checklist.