Developer documentation
Use the Boostsy customer API to list services, place orders, check status, request refills and cancel from your own system.
Use your customer API key to manage orders from your server. Requests use POST /api/v2 and return JSON. Keep keys private.
Authentication
Pass your key as a Bearer token or the key request field. Create and revoke keys in your developer workspace. All orders and balances belong to the authenticated account.
curl -X POST 'https://YOUR_DOMAIN/api/v2' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"action":"services"}'Actions
| action | Fields |
|---|---|
services | — |
balance | — |
add | service, link, quantity |
status | order / orders (up to 100) |
refill | order / orders |
refill_status | refill / refills |
cancel | orders |
Place an order
{
"action": "add",
"service": "SERVICE_ID",
"link": "https://example.com/public-target",
"quantity": 100,
"idempotency_key": "UNIQUE_ORDER_REFERENCE"
}Replace the service ID with an active ID returned by services. Check the error field and HTTP status. If a submission times out, retry with the same idempotency key so it cannot create a second order.
Manage API keys ↗