How to create a Named Credential for Producer Data Sync

Overview

The Producer Data Sync code relies on the presence of a Named Credential with an API name of Producer_Sync. Each customer will have their own unique client ID and secret to be stored in the named credential, so creation of the named credential needs to be a manual onboarding step for your organization. The following sections describe all the steps needed to create the named credential.

Customer API Configuration

Before you undertake the following configuration steps, your AgentSync contacts will setup the Customer API credentials to enable the remaining steps below to be completed. Work together to ensure that it is in motion at least 5 days before the intended date of producer data sync set-up.

Remote Site Settings

In the relevant Manage instance:

1. Create a Remote Site Setting for the Customer API auth endpoint: https://auth.agentsync.io
2. Create a Remote Site Setting for the Producer Data Sync API base URL: https://api.agentsync.io

Auth Provider

1. Go to Set up
2. In the quick find on the left-hand side, type Auth. Providers and create an auth provider by following the following steps:
   1. For the Provider Type, select AgentSyncAuthProvider
   2. For the Name, put “Producer Sync”
   3. For the URL Suffix, put “Producer_Sync”
   4. For the Auth Endpoint, put “https://auth.agentsync.io/oauth2/token”
   5. For the Client Key, put the client key provided to you by the Customer API For the Client Secret, put the client secret provided to you by the Customer API Team.

1. 1. For the Provider Name, put “Producer_Sync”
   2. For Execute Registration As, select an AgentSync admin user.
   3. Click the Save button.

Named Credential

1. Go to Setup
2. In the quick find on the left-hand side, type in Named Credentials and select once it populates. 
3. Click the dropdown arrow next to the “New” button. Select “New Legacy.”
4. After clicking “New Legacy,” fill in the following details:
   1. For the Label, put “Producer Sync”
   2. For the Name, put “Producer_Sync”
   3. For the URL, put “https://api.agentsync.io/contracting”
   4. For the Identity Type, select “Named Principal”
   5. For the Authentication Protocol, select “OAuth 2.0”
   6. For the Authentication provider, select the auth provider created earlier.
   7. Click the Save button.

Troubleshooting

After you click the Save button, the Named Credential should show an Authentication Status of “Authenticated.” If it says “Pending” or any other status, then the authentication was not successful. Please double-check that all of the above information was entered correctly, and contact contractingsupport@agentsync.io for help if needed.