Sandbox

Build and test against an environment that is not production.

Base URL

https://qa.opportunityplatform.co.uk/api

It runs the same code as production, usually a little ahead of it, with a separate database and separate keys. A production key does not work on the sandbox and a sandbox key does not work on production. Ask us for a sandbox key; see Getting started.

What to expect

The data is test data. Counts, jobs and events will not match production and may be reset.
Rate limits and quotas work exactly as on production, so you can test your handling of 429.
New features appear here first. Something you see on the sandbox may change before it reaches production.
The sandbox has no availability commitment and may be briefly unavailable while we deploy.
Webhook deliveries from the sandbox carry livemode: true today, like production. Use separate endpoints and secrets per environment.

Check you can reach it

Should return 401 without a key

curl -s -i "https://qa.opportunityplatform.co.uk/api/v1/jobs" | head -1

Should return 200 with your sandbox key

curl -s "https://qa.opportunityplatform.co.uk/api/v1/jobs?limit=1" \
  -H "Authorization: Bearer $OP_API_KEY"

Previous: Versioning