Skip to main content

Authorization

Follow this guide to create a new FMS:Connect Systems credential that will allow Nexla to authenticate to and exchange data with your FMS:Connect Systems account.
fm_systems_api_auth.png

FMS:Connect Systems

Prerequisites​

Before creating a FMS:Connect Systems credential, you need to obtain a Client ID and Client Secret from your FMS:Connect Systems account. The Client ID and Client Secret are required to authenticate with the FMS:Connect Systems API.

To obtain your Client ID and Client Secret, you need to have a FMS:Connect Systems account with API access enabled. Once you have access to your account, you can generate a Client ID and Client Secret from your FMS:Connect Systems administration portal. The Client ID and Client Secret are used to obtain a bearer token for authentication with the FMS:Connect Systems API. The bearer token is sent in the Authorization header with the Bearer prefix for all API requests to the FMS:Connect Systems API. For detailed information about API authentication setup, refer to the FMS:Connect Systems documentation.

Create a FMS:Connect Systems Credential​

  • To create a new FMS:Connect Systems credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – FMS:Connect Systems

FMSSystemsCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Client ID and Client Secret​

  1. Enter your FMS:Connect Systems Client ID in the Client ID field. This is the Client ID you obtained from your FMS:Connect Systems administration portal.

  2. Enter your FMS:Connect Systems Client Secret in the Client Secret field. This is the Client Secret you obtained from your FMS:Connect Systems administration portal.

    Keep your Client ID and Client Secret secure and do not share them publicly. The Client ID and Client Secret provide access to your FMS:Connect Systems account and should be treated as sensitive information. You can view and manage your API credentials in your FMS:Connect Systems administration portal. The Client ID and Client Secret are used to obtain a bearer token for authentication with the FMS:Connect Systems API. For detailed information about obtaining and managing API credentials, see the FMS:Connect Systems documentation.

Hostname​

  1. Enter your FMS:Connect Systems hostname in the Hostname field. This is the name of your client and is present in your FMS:Connect Systems URL as https://{hostname}.fmshosted.com/fmsconnect/. The hostname is used to construct the authentication and API endpoint URLs.

    The hostname is the name of your client and can be found in your FMS:Connect Systems URL. The hostname is used to construct the authentication and API endpoint URLs. For detailed information about determining your hostname, see the FMS:Connect Systems documentation.

Environment​

  1. Select the environment you want to connect to from the Environment dropdown menu. Available options are:

    • Test: Establishes connectivity with Test Environment
    • Production: Establishes connectivity with Production Environment

    The environment determines which FMS:Connect Systems environment you will connect to. Use the Test environment for development and testing purposes, and the Production environment for production data access. The environment is used to construct the authentication and API endpoint URLs. For detailed information about environment configuration, see the FMS:Connect Systems documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.