Table of Contents


Configuring Open Exchange Rates

 

The Open Exchange Rates API can be configured by administrators to automatically update currency exchange rates. The exchange rates will be updated in relation to the organization’s base currency.

*Note: Only active currencies will have their exchange rate updated.

Requirements

To configure the Open Exchange Rates API, users must be assigned a security role with the following permissions:

  • Administrator System Role

Users also require the following external permissions:

  • Users must be registered on Open Exchange Rates

To configure the Open Exchange Rates API:

 

Connecting the API to Magentrix:

  1. In the Setup Home page, click Extend > Connected Apps.
  2. Click New.
  3. Select API Provider and then click Next.
  4. Select Basic and then click Next.
  5. Configure the following fields:
    • Name: Enter the name of the API. The API name will be used to create a scheduled job.
    • Service URL: Enter "https://openexchangerates.org".
    • Security Token: Enter the App ID from the OpenExchangeRates App ID page.
    • Note*: You may enter anything for the Username and Password fields.
  6. Click Save.

 

Configuring a Scheduled Job:

  1. In the Setup Home page, click Manage > Scheduled Jobs.
  2. Click New.
  3. Configure the fields:
    • Action: Enter the following action: "/sys/CurrencyExchangeRate/UpdateRates?IntegrationName={APIName}&provider=OpenExchangeRate" E.g.: "/sys/CurrencyExchangeRate/UpdateRates?IntegrationName=OE&provider=OpenExchangeRate"
    • Starts On: Select when the scheduled job will begin.
    • Interval: Enter the number of minutes in which exchange rates will be updated.
      Note*: This number is dependent on your Open Exchange Rate plan.
  4. Click Save.

SEE ALSO


<< Using MailChimp |  Using the Data Importer >>