API Info Action

[TimothyBJacobs]

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

The info action is used to retrieve information about a license key.

Request

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

Success

As long as a license key is used for authentication, this request will always be successful.

Code: 200 OK

{
  "success": true,
  "body": {
    "transaction": 423,
    "product": 231,
    "customer": 32,
    "status": "active",
    "max": 5,
    "activations": {
      "count": 2,
      "count_active": 1,
      "list": [
        {
          "id": 143,
          "activation": "2015-05-22T13:45:56",
          "deactivation": "2015-05-29T01:31:45",
          "location": "http://www.install-location.com",
          "status": "deactivated"
        },
        {
          "id": 147,
          "activation": "2015-05-22T13:45:56",
          "deactivation": "",
          "location": "http://www.other-install-location.com",
          "status": "active"
        }
      ]
    }
  }
}

Fields

• success – Boolean field representing if the request was successful.
• body – Object contain the response body.
  • transaction – Originating transaction ID.
  • product – Product this key is licensed to.
  • customer – Customer ID this key belongs to.
  • status – Status of this license key. One of active or expired.
  • max – Maximum number of concurrent activations.
  • activations – Object containing information about this key's activation history.
  • count – Number of total activations.
  • count_active – Number of active activations.
  • count_deactivated – Number of deactivate activations.
  • list – Array listing the activation history of this key.
    • id – Unique id identifying this activation.
    • activation – ISO 8601 representation of the time of activation.
    • deactivation – ISO 8601 representation of the time of deactivation. MAY be empty.
    • location – Location of this activation. SHOULD be unique.
    • status – Status of this activation. One of active, deactivated, expired.

[TimothyBJacobs]

Completed.