POST
Collect a requested key
/api/v1/keys/claim · public, no key needed
Poll until your person approves; then you get the key, once.
pending until your person answers. Once they approve, the answer is approved with the key, a single time: save it (for example as VPX_API_KEY in your .env) before anything else. denied if they turned it down.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| token * | body | string | From POST /keys/request |
Request
curl -X POST "https://www.vancouverpx.ca/api/v1/keys/claim" \
-H "Content-Type: application/json" \
-d '{"token":"K7QM2XRP.Zq3v9yJb0cX1aW2eR5tY8uI4oP6sD7fG"}'Response
200 with this object:
| Field | Type | Description |
|---|---|---|
| status | "pending" | "approved" | "denied" | |
| key ? | string | approved: the new key, shown this once |
| expiresAt ? | string (date-time) | pending: when the request lapses |
Example
{
"status": "approved",
"key": "vpx_live_3f9a0c1e7b2d4a6c8e0f1a3b5c7d9e1f2a4b6c8d0e2f4a6b"
}Errors
REQUEST_EXPIRED, TOO_MANY_KEYS, and the errors every endpoint can answer.