API Tester

Test API endpoints directly from this documentation — no external tools required

Getting Started

How to Use

1. Select Method — GET, POST, PUT, PATCH, or DELETE
2. Enter Endpoint — e.g., /bookings or /bookings/bk_123
3. Add Headers — Add Authorization header
4. Enter Body — For POST/PUT/PATCH requests
5. Click Send — Wait for results

Example Request

# GET all bookings
GET /bookings

# GET single booking
GET /bookings/bk_123456

# POST new booking
POST /bookings
{
  "customerId": "cust_123",
  "serviceId": "svc_456",
  "staffId": "staff_789",
  "dateTime": "2024-01-15T10:00:00Z"
}

---

Try It Now

---

Authentication

Before You Start

You need an API Key before using the API Tester:

1. Go to Settings > API Keys
2. Click Create New Key
3. Set a name and select the desired permissions
4. Copy the Key and store it securely

Enter API Key

Enter your API Key in the Authorization Token field:

Bearer sk_test_REDACTED

---

Common Examples

Get Bookings List

Setting	Value
Method	GET
Endpoint	/bookings
Headers	Authorization: Bearer YOUR_KEY

Create a New Booking

Setting	Value
Method	POST
Endpoint	/bookings
Headers	Authorization: Bearer YOUR_KEY Content-Type: application/json
Body	{ "customerId": "cust_123", "serviceId": "svc_456", "staffId": "staff_789", "dateTime": "2024-01-15T10:00:00Z" }

Update Booking Status

Setting	Value
Method	PATCH
Endpoint	/bookings/bk_123456
Headers	Authorization: Bearer YOUR_KEY Content-Type: application/json
Body	{ "status": "confirmed" }

Cancel a Booking

Setting	Value
Method	DELETE
Endpoint	/bookings/bk_123456?reason=customer_request
Headers	Authorization: Bearer YOUR_KEY

---

Response Codes

Code	Meaning	When
200	OK	Data retrieved successfully
201	Created	Data created successfully
204	No Content	Data deleted successfully
400	Bad Request	Invalid data
401	Unauthorized	Invalid API Key
404	Not Found	Data not found
422	Unprocessable	Validation error
429	Too Many Requests	Rate limit exceeded
500	Server Error	Internal server error

---

Tips & Tricks

Debugging

1. Check JSON — Verify that JSON syntax is correct
2. Check Status Code — See if the request succeeded
3. Check Response Time — If very slow, there may be a network issue

Avoiding Common Issues

Common issues:

1. CORS Error
   - Use the API via Server, not Browser

2. Token Expired
   - Create a new Key and try again

3. Rate Limit
   - Wait 1 minute and try again

4. Invalid JSON
   - Double-check syntax

---

Documentation Links

• API Overview — API overview
• Authentication — How to authenticate
• Bookings API — Manage bookings
• Customers API — Manage customers
• Services API — Manage services
• Staff API — Manage staff