The [[API Key Generator]] is used by a developer or builder to create an authentication token for [[Dev Resources - API|WorkXpress API]] access to the system.

+

===== Accessing the API Key Generator =====

+

+

The API Key Generator can be accessed using the tools section of the [[Block Creator#​WorkXpress Handbook|WorkXpress Handbook]].

+

+

+

{{:​record_inspector_toolbar.png?​direct&​400|}}

+

+

===== Generating an API Key =====

+

+

Generating an API Key requires two pieces of data a User and that users password. ​ When an api call is made that user's preferences will be used when retrieving data from the system. ​ Relevant preferences to consider are timzone, language, and location. ​ If the api is used to save a [[Field|field]] value then the user associated with the key will be used for [[Field Setting - Audit History|auditing]] purposes if that option is selected for the field being saved. The user selected will also be used in [[Query Builder|queries]] that start from the currently logged in user. Sometimes it is recommended to create a API user for your application that has static well known preferences.