On-device API license management
This documentation aims at helping you understand the licensing model of MyScript on-device libraries.
The MyScript pricing model is device-based. A license is defined as the first launch of one application on one device.
An Internet connection is required to launch and run the library. However, a 30-day grace period is offered, from the moment the user first launches your application. A connection will then be mandatory.
As a developer, you have to embed a certificate in your application and to initialize the MyScript library with it. This certificate will identify your application and your user’s device on MyScript servers, when activating the user license.
Application developers have to pre-pay packs of licenses corresponding to the estimate numbers of users using their app. As listed in the Pricing page, a free pack of 100 licenses is offered to every developer registering on the Developer Portal. This should be enough for most developers to develop and start user tests with their app. Extra licenses packs can be bought later at any time.
With your MyScript developer account, you can access your native apps dashboard (formerly called ATK Dashboard). You will be able to download the certificate to embed it in your app and see your remaining pre-activated licenses. It also gives you access to the log console, that is useful to troubleshoot certificate problems while developing.
A certificate is required to use the MyScript handwriting recognition engine and gives the right to use the ATK or the Interactive Ink SDK. Each certificate gives access to all widgets for a given platform.
Here is how to download the certificate for ATK Samples:
- Log in at https://atk.myscript.com.
- Click Open on the ATK Samples application.
- Click on the download icon to download
The top menu contains 2 sections: Applications and Console, described below.
The Applications tab is useful if you develop several applications and you want to keep control of the active ones. Assuming you have developed an application named A: If you remove A from the store, you may want to prevent users from activating a MyScript license related to A.
The Applications tab displays:
- your pack consumption,
- a diagram of your license consumption for all your applications (or a filtered application) on a given period,
- a list of your applications, that you can manage through the Create application, Open and Edit buttons.
Click Open to open an application and thus access a page dedicated to the corresponding certificate(s).
This new page displays:
- a diagram of your license consumption for the application (or a filtered certificate) on a given period,
- your application name and creation date as well as a list of your certificates, that you can manage through the Create certificate, Edit, Disable and download icon buttons. This list can be filtered.
When creating a certificate you should be aware of the rules to set your identifier. They are specifics to every platforms iink SDK and ATK could handle:
- Android, enter the package name that can be found in the AndroidManifest.xml.
- iOS, enter the bundle identifier that can be found in your project’s properties (General tab).
- Windows, enter the bundle identifier that can be found in the Package.appx manifest file, in the Packaging tab.
Those rules are displayed in the interface if you click on the information button (surrounded i).
The Disable button allows you to temporarily suspend a certificate and thus the related application. Click Enable to re-activate the certificate.
The Console tab displays various 30-day-old error logs from the server.