Introduction

The Alkanyx API Service makes it easier for users to have open access to licensing and users statistics related data, which developers can use to build awesome tools and services.

This service is designed to implement the required features of the JSend specification. Data returned from each of the API’s endpoint will be in JSend format. You can find additional information about the specification here.

Registering an App to get an API Key

Getting an API Key quite simple. Just login or register into your account then go to User Settings > API Access under the user menu. There you will able to create a new Alkanyx app that comes with your API Key.

Making your first API call

You can make your first API call by just accessing the link below.

https://alkanyx.com/api/v1/APITest

Private endpoints authentification

In order for the API to accept our request, we will need to send an API key via the Authorization header. The authorization string will look like this, where $api-key is your own personal API key.

"X-Authorization: Bearer $api-key"

Public endpoints

GET /v1/APITest

Description: Example endpoint to test if API is online.

Parameters: None

GET /v1/license/{licenseID}

Description: Check the validity of a provided license ID.

Parameters: licenseID - string of the Alkanyx license you want to check.

Output for https://alkanyx.com/api/v1/license/2432xxx03167cc500be6ff80axxxb3d995f20ax6

{
    "status": "success",
    "data": {
        "itemId": 1337,
        "itemName": "Dummy App template",
        "datePurchased": {
            "date": "2017-06-01 23:10:50.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        }
    }
}
                            

Private endpoints

GET /v1/stats/{me}

Description: Get stats about your Alkanyx user.

Parameters: me - only allowed to see your own stats.

Output for https://alkanyx.com/api/v1/stats/me

{
    "status": "success",
    "data": {
        "itemsPosted": 14,
        "userComments": 32,
        "userSales": 85,
        "userBadges": 7,
        "userFollowers": 12,
        "dateJoined": {
            "date": "2017-02-14 00:36:36.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        }
    }
}