search

iron-bound-designs / exchange-addon-licensing

iThemes Exchange Licensing Add-on
GNU Affero General Public License v3.0
6 stars 2 forks source link

API Download Action #13

Closed TimothyBJacobs closed 9 years ago

TimothyBJacobs commented 9 years ago

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

The download action is used to force the download of the latest version of the software.

Request

URL: https://www.yourstore.com/itelic-api/download/ Verb: GET

Success

If the request is successful, i.e. an active API key, the latest version of the software will be downloaded. Most commonly the software will be in zip format. Code: 200 OK

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 commented 9 years ago

Complete.