Introduction

In a default install of Journyx API Key authentication is disabled.  An Administrator must first turn on the ability to use an API Key, and must then grant the ability to create API Keys to users.


Enable API Keys

  1. As an Administrator in Journyx, head under Settings -> System settings -> Security settings.
  2. In the Security section check "Allow User API Keys to authenticate API requests. Can be used in lieu of passwords for service integrations such as with Zapier."
  3. You may wish to configure "Maximum number of days before an API key expires and must be renewed. Users can request a shorter time but not a longer one" if the default is not suitable.

Grant users the ability to generate API Keys


  1. As an Administrator in Journyx, head under Settings -> Manage fields and roles -> Customize system roles.
  2. First try to locate two roles called: "API Key Generate" and "API Key Sign In".  If you have these two roles, simply assign them to users.
  3. If you do not have those two roles, decide which role makes the most sense to create and use an API Key.  
    NOTE: If this is a "Type: System" role you cannot edit this role so must create a new role.
  4. The two Role Abilities you need to worry about are "API Key - Generate" and "API Key - Sign In"