API Product Action

[TimothyBJacobs]

This issue describes the /product/ API action. An outline of the API is specified in issue #8.

The product action is used to retrieve information about the licensed product.

Request

URL: https://www.yoursite.com/itelic-api/product/ Verb: GET

Success

If the request is successful, i.e. an active API key, the following response will be returned.

Code: 200 OK

{
  "success": true,
  "body": {
    "name": "Your Licensed Product",
    "description": "This is the description of the licensed product.",
    "version": "1.5.4",
    "tested": "4.1",
    "author": "TimothyBlynJacobs",
    "last_updated": "2015-02-15",
    "banner_low": "https://www.yourstore.com/product/banner-low.png",
    "banner_high": "https://www.yourstore.com/product/banner-high.png",
    "package_url": "https://www.yourstore.com/itelic-api/secure-download-link",
    "description_url": "https://www.yourstore.com/product/",
    "changelog": "This is the changelog of your product"
  }
}

Error

This will cover all possible errors, besides an authentication error resulting from not passing any license key. The message string MAY be changed in the future. The error code MUST NOT be changed.

Expired License Key

Code: 402 Payment Required Returned when the license key being used is Expired.

{
  "success": false,
  "error": {
    "code": 02,
    "message": "Your license key has expired."
  }
}

[TimothyBJacobs]

Complete.