Account API
Your personal API key lets scripts read your orders and licence keys and set the installation ID. Create a key in the account under API keys. The key is shown once, starts with swp_ and can be revoked at any time. Treat it like a password.
Base address: https://split-wave.com. Send the key as Authorization: Bearer swp_.... At most 120 requests per minute per key. A closed account's keys are blocked.
| Call | Purpose |
|---|---|
GET /api/v1/me |
your email and registration date |
GET /api/v1/licenses |
orders with the licence status and, once issued, the key |
POST /api/v1/licenses/{order}/install |
body {"install_id":"dsp-..."}: sets the installation and queues the key for signing |
curl -s https://split-wave.com/api/v1/licenses -H "Authorization: Bearer $SWP_KEY"
curl -s -X POST https://split-wave.com/api/v1/licenses/ORDER_ID/install \
-H "Authorization: Bearer $SWP_KEY" -H 'Content-Type: application/json' \
-d '{"install_id":"dsp-0123456789abcdef0123"}'
Licence status: awaiting_install (enter the installation ID), pending (being signed), issued (the key field is filled). The installation ID cannot be changed once set. Errors: 401 bad key, 403 closed account, 404 unknown order, 409 already set, 422 malformed ID, 429 too many requests.
This is separate from the platform API (Platform API), which runs on your own installation.