API Key configuration

With the release of 4ALLPORTAL 3.7 we use an open RESTful API (opens new window) next to our existing REST API. This API allows access with session cookies like before plus access with a new login via an API Key.

There are two ways to create and edit an API Key.

1. For a user with superadmin rights:
   Go to the admin snap-in Developer/API Key settings in the administration area to create and configure API Keys for you and your users.

2. For a user with access to the module API Key:
   Go to the module API Key in the Mega Menu to create and configure API Keys.

Note: The Main menu entry of the module API Key is hidden per default. Set it to "Yes, shown by default" in the Role-based module settings in the snap-in General system configurations/User settings/Role configurations if you want users of a role to create and configure API Keys themselves.

Configure an API Key

In both snap-in and module it is possible to create, delete and view an API Key.

• On view it is possible to change the validity of an API Key and to enable/disable a Key.
• On create you additionally set the user for which an API Key is generated.

Access the new API

To access the new API, set the web request header Authorization to value Bearer API_KEY. Only replace API_KEY with your created and activated Key, for example: 75d6a19f-7e44-4ae5-b81f-7292bc9f774d.