API Key

List of existing API keys set up for external system data access.

Utilized by external partners who have integrated with Bex to retrieve or create data within Bex.

Below, all columns are described:

• Data Scrubbing: Option to specify which information is to be shared. Information not intended for external partners can be scrubbed. Learn more here.
• Gen. Secret: If REST API uses API Secret. Learn more about REST API below. Click the button to generate a password or update an existing one. (Note: Generating a new one will no longer apply to existing ones).
• ID: API Key ID. Internally in Bex.
• API Key: The actual API key used by the external system for access. Click on it (or on the ID) to access the view granting permissions to various parts of the system. Learn more here.
• Description: Name describing the API key's user. E.g. the name of an e-commerce partner.
• Location: The default location used by the API key.
• System: Integration system. Learn more here.
• User: API user. Each API key creates its own user in the system. It does not appear in the User list and applies solely to the API.
• Secret: If REST API is used, the secret must be provided for access.

Extra Cost for API Keys

All active API keys entail an additional monthly cost.

If the API key is no longer in use, set it to Inactive. Click the pencil for editing, uncheck Active, and click the checkmark to save. Deactivating the key will revoke external system access to retrieve information.

REST or SOAP

REST
New integrations should be built against the REST API. Documentation can be found here:
https://developer.bexonline.com/

For REST API, external partners need to obtain the API key and secret for access, along with the API URL.
API URL for REST: https://api.bexonline.com

SOAP
Maintenance/development of previous SOAP integrations is done using SOAP documentation:
http://developers.bexonline.net/

For SOAP, only the API key and API URL are used.
For SOAP, API URL is: https://"customername"-api.bexonline.net/

Setting Up a New API Key

• Click "Create".
• Fill in the description.
• Select "Location" if the API key should be linked to a location.
• Click Save.

Configure permissions, data scrubbing, and system settings.