API Implementation

Recommended Steps for Protecting Applications with API

To protect your application with API, we recommend the following steps:

Familiarize yourself with the API (see integration, use and Smarx Compendium chapter 10). Choose a suitable API and review the sample code for your environment.
Check our notes on secure integration in the Smarx Compendium chapter 17.
The easiest way to configure the CRYPTO-BOX for your application with the required protection and licensing setting is to use it with the Smarx Application Framework (SxAF, see Smarx Compendium chapter 4.5):
- Start SxAF on your computer:
  Select “SxAF Client” in the start menu under MARX Smarx OS PPK.
- Create a new SxAF project and enter "Implementation with API" as the project type.
- Select the project-specific values for the CRYPTO-BOX, e. g. label and AES keys.
- Select the license options for your by defining one or more partitions for data objects with license information. These can be expiration dates, counters, network licenses and/or customer specific memory objects (see Smarx Compendium chapter 4.5.5 for further details).
- Use the “CB Format” option in SxAF to format your CRYPTO-BOX units with the project settings. You can optionally export your project settings to a XML file in order to use the command line tools (further information can be found in Chapter 4.9 of the Smarx Compendium).
If you want to update your CRYPTO-BOX later at the end-user, use the Remote Update Tool and send the update together with the CRYPTO-BOX to your end-user (see Smarx Compendium Chapter 4.10.3 for more information).
Test all licensing options carefully.
Send your protected application togehter with the CRYPTO-BOX and the additional files such as drivers and, if necessary network server for network licensing).

MARX provides an easy-to-use redistribution setup.

Further information can be found in our Application Notes Driver Installation CRYPTO-BOX.