If you own the Enterprise License (See Software Licenses) you can configure your Schema Engine software to create API Keys which will unlock the Enterprise Features as well as the Visual Studio API for the Schema Engine. You must be running version 6.6.0 or later to use the Enterprise License.

 

Click to Zoom

Use Your Schema Engine to Create API Keys

 

To have the Schema Engine generate API Keys. When creating or editing your database schema click DB Maintenance on the toolbar and then as shown in the screenshot above:

 

1.Check Generate Schema Engine API Key

2.Enter the API Key ID. This is any 4 - 8 character alphanumeric value you like with the only caveat being that you cannot use the same API Key ID in another database schema. This API Key ID will be used by the Database Maintenance Service when naming the API Key File(s) it will export. Files will be named APIKey.<api key id>.txt

3.Check Allow the API to Alter Schema Tables. While this is technically optional, you must check this box if you want any application which uses your API Key to be able to perform Schema Training.

4.Check Export the API Key to a folder also. Which will make #5 visible.

5.Choose the folder where the maintenance service should export this API Key File to by clicking the button.

 

Save your changes and restart the Database Maintenance (if it was running). You should see your API Key file appear in the export folder a few seconds later.

 

What is an API Key?