API Authentication
To get started with Salesforce in Mongoose, there are a couple of simple (but critical) things that will need to be setup in your Salesforce instance. In general, the following pieces of information are needed:
- Your instance URL (for example: https://mongooseu.my.salesforce.com)
- The Client ID and Client Secret of an External App (Recommended) or a Connected App (Legacy) you have created in Salesforce
- The Username and Password with Security Token of an API user you have created in Salesforce
Creating an External App (Recommended)
The Salesforce documentation for creating a connected app can be found here. If this guide is not sufficient or if you need additional information, please see that guide for additional help.
Start by searching “External Client App Manager” in the quick find box and selecting “App Manager”. Click “New External Client App”.
Then, fill out the form, making sure to check “Enable OAuth Settings” and add “ https://sms-api.mongooseresearch.com/” as a callback URL. Please be sure to set Permitted Users to "All users may self-authorize."
After that, we need two permissions:
- Manage user data via API's (api)
- Perform requests at any time (refresh_token, offline_access)
After the app is created, you will be shown a screen of information related to it. We need two pieces from this screen: The Consumer Key which serves as the Client ID and the Consumer Secret which serves as the Client Secret.
Creating a Connected App (Legacy)
The Salesforce documentation for creating a connected app can be found here. If this guide is not sufficient or if you need additional information, please see that guide for additional help.
Start by searching “App” in the quick find box and selecting “App Manager”. Click “New Connected App”.
In the Classic Experience, start by searching “Apps” in the quick find box and selecting “Apps” under Build > Create. Click “New” under “Connected Apps”.
Then. fill out the form, making sure to check “Enable OAuth Settings” and add “ https://sms-api.mongooseresearch.com/” as a callback URL. Please be sure to set Permitted Users to "All users may self-authorize."
After that, we need two permissions:
- Manage user data via API's (api)
- Perform requests at any time (refresh_token, offline_access)
After the app is created, you will be shown a screen of information related to it. We need two pieces from this screen: The Consumer Key which serves as the Client ID and the Consumer Secret which serves as the Client Secret.
Troubleshooting
If you are having difficulty verifying credentials on the API Authentication page in Mongoose or not seeing any reports or list views show up, please check the following items:
- Ensure that your Instance URL is accurate. This should begin with "https".
- Ensure that your API user does not have a user profile assigned in Salesforce that does not have the required permissions set.
- Check the "Session Security Level Required at Login" setting and make sure it is blank. If there is a setting there, remove it.
