Recording API v1 sandbox
A test environment for the partner Recording API. It implements the same contract as production (guide, OpenAPI reference, openapi.yaml), but no real cameras are involved: the outcome of each order is chosen by the court key.
Base URL: https://apibox.pdleye.com/api/v1
1. Get a key
Create a sandbox account in the portal. You get an API key, a webhook secret and the test courts below. Sandbox keys work only in the sandbox.
2. Test courts
| court_key | Behaviour |
|---|---|
sandbox-court-1 | queued → processing → ready, about 30 seconds. |
sandbox-court-2 | queued → processing → ready, about 30 seconds. |
sandbox-slow | Same as ready, but processing takes about 3 minutes. |
sandbox-no-footage | Ends as failed with error.code no_footage. |
sandbox-camera-offline | Ends as failed with error.code court_unavailable (order accepted, video not retrieved). |
sandbox-processing-error | Ends as failed with error.code processing_failed. |
sandbox-unavailable | POST /orders always returns 503 court_unavailable with Retry-After; no order is created. |
sandbox-flaky | Every other new order is created but the response is 500 internal_error, as if it was lost. Retrying with the same client_order_id returns the order with 200. |
3. Try it
export KEY='key_xxx.secret'
export BASE='https://apibox.pdleye.com/api/v1'
curl -s $BASE/courts -H "Authorization: Bearer $KEY"
# a 90-minute session that ended 5 minutes ago
START=$(date -u -d '-95 min' +%Y-%m-%dT%H:%M:%SZ); END=$(date -u -d '-5 min' +%Y-%m-%dT%H:%M:%SZ)
curl -s -X POST $BASE/orders -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' \
-d "{\"court_key\":\"sandbox-court-1\",\"start\":\"$START\",\"end\":\"$END\",\"client_order_id\":\"test-1\"}"
curl -s $BASE/orders/ord_... -H "Authorization: Bearer $KEY"
Sandbox limits and differences
| Interval length | 15–180 minutes, end in the past |
| How far back | 7 days (interval_too_old beyond that) |
| Request rate | 60 requests per minute per key → 429 rate_limited with Retry-After |
| Orders in progress | At most 10 queued/processing orders per account → 429 |
| Webhook retries | Backoff 10,30,120,600,1800,3600 seconds, for up to 24 h |
| Key/secret notifications | Shown in the portal activity log instead of e-mails |
share_page_url | Points to a placeholder page in the sandbox |
Data in the sandbox can be reset at any time.