| Initial Build | 2017.1.06 |
| Module | Accounting |
| Current Setting Type | Text Box |
Modules > Admin > System Options > Find System Option
Use this system option to specify the multicurrency API key generated on https://fixer.io API service for currency rate conversion. It is a unique key assigned to your API account, used to authenticate NetForum with the fixer.io service for currency rate conversion. The default for this option is empty.
For information on how to obtain your multicurrency API key, refer to the Obtaining Your Multicurrency API Key section in this article.
Current Setting
The current setting for MulticurrencyAPIkey is used as follows:
Values: This system option can be set to any valid multicurrency API key generated on https://fixer.io API service for currency rate conversion.
Default Value: empty
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
Obtaining Your Multicurrency API Key
To ensure accurate and up-to-date currency rate conversions within NetForum, you will need to provide an API key from the fixer.io web service.
Here's how to get your API key and update the system option:
1. Obtain Your Multicurrency API Key
To generate a unique API access key:
- Navigate to the Fixer.io service site: https://fixer.io
- Sign up for an account. We strongly recommend using a generic mailbox (e.g., info@yourcompany.com or it@yourcompany.com) for sign-up. This ensures that access to the API key is not tied to a single individual and maintains continuity of service.
- Once successfully signed up, your unique API access key will be generated and available on your fixer.io dashboard.
2. Update the MulticurrencyAPIkey System Option
After you have generated your API key, you need to enter it into the MulticurrencyAPIkey System Option:
- Go to your NetForum iWeb application.
- Locate the MulticurrencyAPIkey System Option (Admin module > System Options group item > Find or List System Options group item link).
- Purpose: This system option sets the multicurrency API key generated on the data.fixer.io API service.
- Enter your newly generated API key into the Current Setting field of the MulticurrencyAPIkey system option. Save the changes to the system option.
Once these steps are completed, your NetForum application will be able to retrieve accurate currency conversion rates from fixer.io.