Getting Started

Authentication

All API requests require an API key. You can generate keys from your dashboard after signing up.

Include your API key in the X-Api-Key header on every request:

curl -H "X-Api-Key: swa_your_api_key_here" \
  https://simplewebapis.com/api/qrcode \
  -d '{"text": "Hello World"}'

Making Requests

Most APIs support both POST (JSON body) and GET (query parameters) methods. The base URL for all API requests is:

https://simplewebapis.com/api

JSON-based APIs return responses in the ApiResponse envelope format:

{
  "success": true,
  "message": null,
  "data": { ... }
}

Image APIs (QR Code, Barcode, Data Matrix, Stylised QR Code) return raw PNG files, and document APIs (Invoice, Quote, Receipt, Purchase Order, Packing Slip) return raw PDF files.

Errors

APIs return standard HTTP status codes and structured error responses:

• 400 Bad Request - invalid input parameters
• 401 Unauthorized - missing or invalid API key
• 402 Payment Required - no active subscription
• 403 Forbidden - API key not scoped to this API or origin not allowed
• 404 Not Found - endpoint or resource not found
• 410 Gone - this API is currently disabled
• 429 Insufficient Credits - not enough credits for this request
• 500 Internal Server Error - something went wrong on our end

{
  "success": false,
  "message": "Text is required.",
  "data": null
}