CheckoutKeys API Documentation

API Documentation

Welcome to the CheckoutKeys API documentation. This API allows you to manage license keys for your digital products sold via Stripe checkout. To use this API, you'll need an API key for authentication.

Get your API key in your dashboard by logging in to CheckoutKeys and navigating to Settings.

Base URL

The base URL for all API endpoints is:

https://checkoutkeys.com

Authentication

To authenticate your requests, include your API key in the request headers or as a query parameter:

Request Header

x-api-key: YOUR_API_KEY

Query Parameter

/api/endpoint?api_key=YOUR_API_KEY

API Endpoints

License Key Validation

GET/api/licensekeys/validate

Get License Key Status

GET/api/licensekeys/status

Activate or Deactivate License Key

POST/api/licensekeys/activateDeactivate

Error Handling

When an error occurs, the API returns a JSON response with a status code and error message:

{
  "status": "error",
  "message": "Description of the error"
}

Common Error Responses

400 Bad Request - Invalid input or parameters
401 Unauthorized - Invalid or missing API key
404 Not Found - Resource not found
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server-side error

Rate Limits

To ensure the stability of our service, API requests are subject to rate limiting:

Plan	Rate Limit
Free	60 requests per minute
Professional	300 requests per minute
Business	1,000 requests per minute

Code Examples

Here are some code examples to help you get started with the CheckoutKeys API using different programming languages.

cURL

# Replace with your actual API key
apiKey="YOUR_API_KEY_HERE"

# License Key Validation (GET)
licenseKey="LICENSE_KEY_TO_VALIDATE"
curl -X GET "https://checkoutkeys.com/api/licensekeys/validate?licenseKey=$licenseKey" \
  -H "x-api-key: $apiKey"

# Get License Key Status (GET)
licenseKeyToCheck="LICENSE_KEY_TO_CHECK"
curl -X GET "https://checkoutkeys.com/api/licensekeys/status?licenseKey=$licenseKeyToCheck" \
  -H "x-api-key: $apiKey"

# Activate or Deactivate License Key (POST)
curl -X POST "https://checkoutkeys.com/api/licensekeys/activateDeactivate" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $apiKey" \
  -d '{
    "licenseKey": "LICENSE_KEY_TO_ACTIVATE_OR_DEACTIVATE",
    "action": "activate"
  }'

Need more help?

If you have any questions or need assistance, feel free to contact us at support@checkoutkeys.com