Connected Apps

Prev Next

Several Revenova-supported integrations require a Salesforce Connected App to communicate data between the TMS and the integration partner. Create a Connected App for each third party integration the customer uses. Run the Connected App as the API User.

For more information, see Salesforce documentation about Connected Apps.

Integration Partners

The following partner integrations require a Connected App to send information to and from a customer org. The steps below show how to create a new Connected App or to complete the setup of a packaged Connected App. Some Connected Apps are packaged in the TMS. Additional setup is required for these existing Connected Apps before they may be used. See the Verify Connected App section below to finish the setup of packaged Connected Apps.

See additional Salesforce API integration information here.

Best Practices

  • Create a Connected App for each required integration used in the customer org.

  • Create 1 API User and add the appropriate packaged Permission Set(s) to that user for each required integration.

  • The API User requires a TMS license.

API User

Create a single API User to run the Connected Apps for a customer org. Add the appropriate permission sets for only the required integrations a customer is using.

Create the API User

  1. Navigate to Setup → Users, click New User and create a User with the following values.

    1. First Name: API

    2. Last Name: User

    3. Email: Set to the System Administrator’s email address.

    4. Username: Automatically generated. Change if necessary.

    5. User License: Salesforce Integration

    6. Profile: Minimum Access - API Only Integrations

    7. Active: Checked.

  2. Set the remaining required User fields as desired.

  3. Click Save.

  4. Navigate to the list of Users and select the API User.

  5. From the Permission Set Assignments section, click Edit Assignments.

  6. Select each permission set for all integrations the customer uses. Click the Add button to add the permission set(s) to the Enabled Permission Sets column. The following permission sets are packaged in the TMS and intended for use with the associated integration in parentheses.

    1. Border Connect API User (Border Connect)

    2. Comdata API User (Comdata Fuel Cards)

    3. Highway API User (Highway Carrier Onboarding)

    4. TMS Accounting Integration (Pub/Sub Accounting)

    5. TMS Blue Yonder API (Blue Yonder)

    6. Trimble API User (Trimble Maps)

  7. Click Save.

Setup Connected App Access

Connected Apps allow third-party applications to integrate with Salesforce by using APIs with standard protocols to authenticate and authorize these applications. Create a Connected App for each partner integration that requires one. While the API User is used by multiple Connected Apps, a single Connected App does not work for multiple partner integrations.

See Salesforce Connected App information here.

Create all required Connected Apps by following the steps below.

The Blue Yonder integration has additional steps outlined below. Complete the additional Blue Yonder setup steps before navigating from the Connected App setup.

Step 1: Allow Authorization Code and Credentials Flows

  1. From Setup → search and select OAuth and OpenID Connect Settings.

  2. Set Allow Authorization Code and Credentials Flows to On.

Step 2: Enable App Creation

  1. Navigate to Setup and search for External Client Apps and select the Settings link.

  2. From the Connected Apps section, choose On for Allow creation of connected apps.

    1. Click the Enable button on the modal to create Connected Apps.

Step 3: Create New Connected App

Create a Connected app by following the steps below. (Border Connect is shown as an example.)

  1. Click the New Connected App button.

  2. Enter the following information.

    1. Connected App Name: Blue Yonder.

    2. Contact Email: System Admin's email.

    3. Enabled OAuth Setting: Checked (true).

    4. Callback URL: https://login.salesforce.com/.

    5. Selected OAuth Scopes: Add Manage user data via APIs (api).

    6. Enable Client Credentials Flow: Checked.

  3. Click Save.

Step 4: Access the Consumer Key and Consumer Secret

Several integrations require the Consumer Key and Consumer Secret to complete setup. Typically, the Consumer Key and Secret information must be sent with the 18-Character Organization Id to Revenova to complete setup. See the specific integration documentation to determine if this information is required before completing the following steps. Instructions to find the 18-Character Organization Id are provided below.

  1. Navigate to Setup App Manager.

  2. Find the row for the integration and click the caret and select View. (Border Connect is shown as an example.)

  3. Click the Manage Consumer Details button.

  4. Salesforce sends a verification email to the system admin's email address. Enter this code in the Verify Your Identity page.

  5. Copy the Consumer Key and Consumer Secret for later use.

Copy 18-Character Organization Id

  1. From the Setup drop-down, choose Developer Console.

  2. Select the Query Editor tab.

  3. Enter SELECT Id from Organization into the field.

  4. Click the Execute button.

  5. Copy the 18-Character Organization Id for later use.

Step 5: Set Client Credentials Flow Run As user

  1. Navigate to Setup App Manager.

  2. Find the row for the integration and click the arrow and select View. (Border Connect is shown as an example.)

  3. From the connected app, click the Manage button at the top of the page.

  4. Click the Edit Policies button.

  5. In the Client Credentials Flow section, use the search button to set the Run As user to the API User created above.

  6. Click Save.

Add Trusted IP Range for OAuth Web Server Flow

  1. If you navigated away from the newly created App, go to Setup → App Manager.

  2. Find the Blue Yonder from the list of apps.

  3. From the caret, Click View on the Blue Yonder app.

  4. Go to the Trusted IP Range for OAuth Web Server Flow section and click New.

  5. Add the following IP ranges (repeat step 4 for each IP range).

    1. Start IP Address, End IP Address: 20.122.40.48.

    2. Start IP Address, End IP Address: 52.177.14.131.

    3. Start IP Address, End IP Address: 52.247.78.106.

  6. Click Save for each IP range.

Domain URL

The following endpoints are sent to Blue Yonder for setup within their system. Each org. must send these endpoints to Blue Yonder to complete setup.

Note that “{domain}” can be found under Setup → My Domain Settings → Current My Domain URL.

  1. OAuth authorization endpoint: https://{domain}/services/oauth2/token

  2. Quote request endpoint: https://{domain}/services/apexrest/rtms/blueyonderloadservice

  3. Tender request endpoint: https://{domain}/services/apexrest/rtms/blueyondertenderservice

The accounting partner requires the domain for setup within their system. Each org. must send their domain to the accounting partner to complete setup.

Note that “{domain}” can be found under Setup → My Domain Settings → Current My Domain URL.

Some integrations are provided in the TMS package with a pre-built Connected App (Border Connect, Highway, Trimble Maps, and others). For these existing Connected Apps, complete the following steps required for initial setup. (Border Connect is shown below as an example.)

Confirm that Connected Apps are enabled.

  1. Navigate to Setup → External Client Apps and select the Settings link.

  2. From the Connected Apps section, choose On for Allow creation of connected apps.

    1. Click the On button to enable creating Connected Apps.

  1. Navigate to Setup  App Manager and find the integration Connected App (Border Connect API Connect.)

  2. Find the integration from the list and choose the caret, select Edit.

  3. Check the Enable Client Credentials Flow box.

  4. Click Save.

  5. Return to Setup App Manager.

  6. Find the Connected App from the list and choose the caret, select Manage. (Border Connect API Connect.)

  7. Choose the Edit Policies button.

  8. In the Client Credentials Flow section, find the Run As field.

  9. Click the Run As Lookup button.

  10. Select the API User created above.

  11. Click Save.