Follow

Generating API Keys

Created by: Thomas Vieth
Created date:
Last Updated date:

To generate an API key to authenticate with the Quin-C service, you will require a CodeMeter License dongle with the ADAPI tag (with current expiration date) applied as a license attribute of your AD Enterprise license.

tempsnip.png

There are 2 methods to generate keys, one through FTK / Lab / Enterprise and the other via the Quin-C interface (provided the browser has valid cookies cached). See the relevant section of this article that corresponds to how you wish to generate API keys.

API Key Generation (FTK / Lab / Enterprise)

As long as this dongle is plugged into the machine when you start the FTK.exe you will be able to generate API keys through the application. The FTK client has the ability to generate API keys by selecting the "Access API Key" option from the Tools menu item. 

mceclip0.png

In the new window that is created by selecting this option, you can select the user to generate an API key for. The user selection is used to define the permissions that the bound API key should obtain. Typically you will want to bind this to the Administrator so that the API key has access to all of the REST calls. By clicking "Generate Key", the text box above will populate with the relevant API key.

mceclip1.png


API Key Generation (Quin-C)

Once the dongle is plugged in and CodeMeter recognizes the device, the Quin-C service will be able to recognize the key. Simply logging into the Quin-C platform as normal will push validated cookies into your web browser, which is how the API key generation authenticates that it should release them. Upon logging into the Quin-C interface, go to the URL bar and we will need to manipulate the URL that Quin-C has redirected you too.

mceclip2.png

We must replace the ADGViewer.html#/review with api/security/{userid}/getenterpriseapiguid and we must replace the {userid} with the applicable userid for the user we logged in with. So to generate the Administrator's API key, the userid would be replaced with 1000. An example is shown below:

mceclip3.png

Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk