Salesforce
To obtain the necessary credentials (Instance name, Client ID, Client Secret, Username, Password, and Security Token) for accessing the Salesforce API, follow these steps:
1. Create a Salesforce Connected App
Log in to Salesforce:
Log in to your Salesforce account with sufficient permissions to create connected apps.
Navigate to Setup:
Click on the gear icon (⚙️) in the upper right corner and select "Setup."
Create a Connected App:
In the Quick Find box, type "App Manager" and select "App Manager."
Click on "New Connected App" in the upper right corner.
Fill in the following fields:
Connected App Name: Choose a name for your app. We suggest that you call it "Adway".
API Name: This will be auto-filled based on the Connected App Name.
Contact Email: Enter your email address.
Enable OAuth Settings:
Scroll down to the "API (Enable OAuth Settings)" section and check "Enable OAuth Settings."
Under "Selected OAuth Scopes," add the following scopes:
Full access (full)
Perform requests on your behalf at any time (refresh_token, offline_access)
Save your connected app.
Get Client ID and Client Secret:
After saving, you will be directed to a page with the details of your connected app.
Save the Consumer Key (Client ID) and Consumer Secret (Client Secret).
2. Obtain the Security Token
Log in to Salesforce:
Log in to the same Salesforce account used to create the connected app.
Reset Security Token OR retrieve the existing Security Token
Reset the Security Token
Click on your profile icon (avatar) in the upper right corner and select "Settings."
In the left-hand sidebar, under "My Personal Information," click "Reset My Security Token."
Click the "Reset Security Token" button. A new security token will be sent to your registered email address. NB! Only reset the Security Token if you're positive that it's not used for any other applications.
Retrieve the existing Security Token
Open your email inbox.
Search for "Salesforce security token".
If you have previously set up a security token you should find an email like the one below.
Save the Security Token.
3. Share login credentials
Log in to Salesforce:
Log in to your Salesforce account with administrative privileges.
Navigate to User Management:
Go to Setup.
In the Quick Find box, type Users and select Users under Users.
Create a New User:
Click New User.
Fill in the required fields:
First Name: (e.g., API)
Last Name: (e.g., User)
Alias: (e.g., APIUser)
Email: Enter a valid email address (you will use this to log in).
Username: Enter a unique username in the form of an email address (e.g., apiuser@yourcompany.com).
Nickname: (e.g., APIUser)
Role: Select an appropriate role if needed.
User License: Salesforce (default).
Profile: Select a profile with sufficient API access permissions, typically System Administrator or create a custom profile.
Ensure the Generate new password and notify user immediately checkbox is checked.
Click Save.
Access Instance name
Log in to Salesforce:
Log in to your Salesforce account.
Check the URL in the Browser:
Look at the URL in your browser’s address bar after logging in. The instance name is part of the URL.
Example:
https://na1.salesforce.com
orhttps://eu2.salesforce.com
na1
oreu2
, would be your instance name.
One you have saved your Instance name, Client ID, Client Secret, Username, Password, and Security Token, make sure to share these - safely - with your contact person at Adway.
Last updated