In this article
Note
The following configuration must be done to provide GoldFinch Read/Write access to an external Software Provider.
Create a New User with the Correct Permissions/License
- Acquire a Salesforce license for a new user.
- API (or limited) license (lower cost)
- A Standard Salesforce license is not required (more expensive)
- Create a new User.
- Name the user as api.[edi software provider name]@[client's domain]
- Example: api.trinity@beyondbetterfoods.com.uat
- User License must be Standard Platform.
- Profile must be Standard Platform User.
- Assign GFERP Extension App and GFERP Standard ERP Users
- If in a Production Environment, assign a GFERP license.
- Reset the new user's password.
The configuration must be completed in the UAT instance first, followed by the PROD instance. Use an internal support email as the email address.
Create an External Client App
-
In Setup, click Apps → External Client Apps → External Client App Manager, click New External Client App.
-
In the Basic Information section, enter an app name and a contact email.
-
In the API (Enable OAuth Settings) section, enter the callback URL and specify OAuth Scopes. Check Enable Client Credential Flows. Click the Create button at the bottom to create the app.
- Before the Go-Live, update the email address to the email address of the EDI partner.
- Integral: goldfinch_api@integralgroup.ca
- Infoconn: support@infoconn.com
-
Make sure Enable OAuth Settings is checked.
-
Open the OAuth Usage that was created automatically. Click the Edit button.
-
Check Enable Client Credentials Flow.
Enable Client Credentials Flow - bypass the credentials input that is required by OAuth 2.0, where users need to provide their credentials in a pop-up window to authenticate. -
Click Save.
The Consumer Key can be retrieved from the Settings tab by clicking on the Consumer Key and Secret button.
Test the Login Credentials
-
Download and install Postman API client API Client for REST, SOAP, & GraphQL Queries | Postman.
-
The post URL is https://yourdomain.my.salesforce.com/services/oauth2/token. Please update "yourdomain" in the URL with your domain.
-
In the Body, specify the following parameter.
-
Click the Send button. If successful, Salesforce will return a response containing an access token.
-
Test a transaction.
The basic request URL: https://yourdomain.my.salesforce.com/services/data/v6.0/
Copy and paste the access token in the #2 field
Enter Bearer in the #3 field.
Click the Send button, and Salesforce should return a result. In the screenshot below, we queried the sales order object, and Salesforce returned a list of sales orders.
Credentials to Share with the External Partner
Please provide the following parameters to the EDI partner, along with the Postman success message screenshot, for the UAT and PROD environments.
- Token URL
- Request URL
- Consumer Key
- Consumer Secret
- Username
- Password
Additional Support Documentation
Salesforce supports both SOAP and REST.
Salesforce API governor limits - Salesforce Developers
Salesforce API documentation links - https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_rest
Comments
0 comments
Please sign in to leave a comment.