Set Up The Fusion XI API

After installing the Fusion XI API, configure the API user and the Central database connection using the Fusion Portal. These steps must be performed directly on the server or machine where the API is installed.

Activity Steps

  1. Open the Fusion Portal.
  2. Click the QR-code icon in the top right corner.
  3. Select API Config.

    The API Configuration window displays.

  4. Enter the following information:
    • Username—The SQL user ID that was created in Configure a Fusion API (Super User).
    • Password—The SQL password associated to the SQL user.
    • Default Database—The default database type. Set to Central.
    • Network Port—The Fusion XI API uses a specific port to communicate and validate user logins. By default, this port is set to 4589, but you can change it if required.

      Note: The selected port must be open and accessible for the API to function correctly. Ensure that firewalls and network configurations allow traffic through this port on both the server and client sides.

  5. Click Save Configuration.

    If the connection is successful the External Transfer API Configuration has been successfully updated message displays.

    Note: Please contact Datamine support if there are any errors (provide a screen capture if possible).

  6. Click OK.

    Note: When configured, the API settings are saved to a file named ApiConfiguration.json, located in, C:\ProgramData\Datamine\GDMS. The password is securely salted before being stored, ensuring added protection of authentication credentials.

  7. To configure the connections to point to the Central database, click the Tools icon in the top right corner.
  8. Click Fusion Connections.
  9. Enter the following API host and Central database or database information:
    • Select Connection—Select Central.
    • Connections Name—It is recommended that you name your connection Central.
    • Server—The server name or SQL instance hosting the Central database.
    • Database—Your SQL Server Fusion Central database name.
    • Authentication—Select the authentication method used by the API’s master user when validating logins. In most cases, select Database as the preferred method.
    • API URL—Enter the IP address or machine name of the server hosting the API. While it is recommended to host the API on the same machine as the Central database for optimal performance, this is not strictly required.
    • API Port—Specify the port used to communicate with the API. Default: 4589.

      Note: Ensure this port is open and accessible. Add both inbound and outbound exceptions for the selected port in your firewall settings to allow uninterrupted communication between clients and the API.

    • SSL Enabled—Applicable if using advanced security and Internet Information Services (IIS) to host the API. Default: OFF.
  10. Click Test Connection. The result should be Connection Successful. If the connection fails:
    • Ensure the API service is running.
    • Verify that the configured port is open and not blocked by a firewall.
    • Confirm that the server and database names are correct and accessible from the machine you are using.
  11. Click Save Connection to save your changes. The Central connection has now been configured.

    Note: If you choose to test the connection, it may fail if the API is not yet running. Ensure the API service is started before performing the test.

  12. Close the Fusion Portal.

    Note: The configuration information is saved to a file named FusionConnections.json, located in C:\ProgramData\Datamine\GDMS\Databases. This file is stored locally on the user’s machine and contains the connection details defined in the Fusion Portal.