CORE API

CORE API

COMMON PARAMETERS

Most API methods require all or some of the following parameters:

  • isv_id: This can be found in the Info area of SLASCONE.
  • product_id: This can be found in the Products area of SLASCONE. Select your product and click on the Copy Key icon.
  • client_id: Each to be licensed client, needs to generate a unique device id.
  • license_key: This is the license key generated from SLASCONE. It consists of n tokens. A license key can be used/activated n times.
  • token_key: A license consists of n tokens. A token key can be used/activated only once (one client).

BASIC FUNCTIONS

These are the fundamental functions you need to integrate in your software. You need to provide an area in your software in which the end user can

  1. enter the provided license code (ACTIVATION)
  2. update/sync the license (HEARTBEAT)

Make sure that your environment has at least 1 license, in order to be able to test these functions.

LICENSE ACTIVATION

POST /isv/{isv_id}/provisioning/activations

The licensing lifecycle begins with the activation of a device. In most cases, you need to provide an area in your software, in which the end user can enter the provided license code. Upon entering the license code, your software should call this method.

SLASCONE provides 2 types of license keys:

  • License key: when you create 1 license with n tokens, SLASCONE generates 1 license key and n token keys. The license key can be used n times for activation.
  • Token key: a token key can be used only once for activation.

The activation might fail for several reasons:

  • The license is not active (inactive or expired).
  • The license key is already activated on a different client (to prevent license piracy).
  • The license has not any available tokens left (all tokens are already assigned).

CLIENT REACTIVATION WITH A NEW LICENSE

In case you activate an already activated client with a new license, the old license becomes automatically available again.

HEARTBEAT

POST /isv/{isv_id}/provisioning/heartbeats

After activating a client, you need to make sure that your software periodically communicates with SLASCONE in order to sync the license data. The response body of the heartbeat method is very similar to the one of the license activation.

Beyond licensing purposes, when calling the heartbeat method your software needs to send its software version and operating system. This data is used in the Analytics area of SLASCONE.

ERROR HANDLING

The license activation or heartbeat might fail for a number of reasons. SLASCONE provides a comprehensive error handling framework.

ANALYTICS

ANALYTICAL HEARTBEATS

Used to collect custom (beyond the standard fields operating system and software version) analytical data. Typically used, when the last recorded value (not the history) is more important. Nevertheless, the value history is saved. Analytical fields can be numerical or alphanumerical. Then, you can use the following method in order to generate analytical heartbeats:

POST /isv/{isv_id}/data_gathering/analytical_heartbeats

USAGE HEARTBEATS

Used to collect data about feature usage. Typically used for time-based analysis e.g., how many times a feature was used last week/month/year etc.

POST /isv/{isv_id}/data_gathering/usage_heartbeats

ALL DOCS


Search

Docs