Configuring Salesforce as the Source: A Comprehensive Guide
Overview
This guide provides a comprehensive walkthrough for configuring Salesforce as a data source in eZintegrations. It explains how to select Salesforce as a product, define business objects, configure API endpoints, and set up OAuth 2.0 authorization.
By following these steps, users can establish a secure and efficient connection between Salesforce and eZintegrations.
When to Use
Salesforce should be configured as a source when organizations need to extract and synchronize CRM data with other business systems.
- When integrating Salesforce with ERP, analytics, or data platforms
- When automating CRM data synchronization
- When generating reports using SOQL queries
- When centralizing customer and account information
Data Source
Step 1
On the Data Source page, select the source type as API.
Step 2
Select Salesforce as the product.
Step 3
Choose the appropriate business object based on your integration requirements.
Note: If the required product or business object is not available, select Create New in the product name field and provide the necessary details.
Note: Selecting Create New requires users to enter all mandatory API configuration information.
Step 4
After selecting the business object, such as Account Information, the system loads all required prerequisites.
Provide the following details in the API Endpoint URL:
- domain name: Replace
{{domain name}}with your Salesforce instance domain
Example: yourdomain.my.salesforce.com - version: Replace
{{version}}with the API version
Example: v52.0 - query: Replace
{{query}}with your SOQL query
Example: SELECT+name+FROM+Account
Note: Requests can be made using standalone APIs or by leveraging SOQL queries within the REST API.
Sample SOQL Format
https://{{domain name}}/services/data/{{version}}/query?q={{query}}
Example: Filtering by Custom Field Values
https://{{domain name}}/services/data/{{version}}/query?q=SELECT+id__c,backorder__c,Brand__c,Category__c,Created_Date__c,Supplier__c,Location__c,Item_Name__c,Item_Number__c+FROM+Item__c+WHERE+Location__c='New-York'
Example: Filtering by Minimum and Maximum Time Values
https://{{domain name}}/services/data/{{version}}/query?q=SELECT+Id,Backorder__c,Brand__c,Category__c,Created_Date__c,Supplier__c,Location__c,Item_Name__c,Item_Number__c+FROM+Item__c+WHERE+Location__c='New-York'+AND+Created_Date__c>='2023-01-01T00:00:00Z'+AND+Created_Date__c<='2023-12-31T23:59:59Z'
Step 5: Authorization (OAuth 2.0)
When Salesforce is selected as the product, OAuth 2.0 authorization is automatically configured.
Refresh Token Configuration
Refresh Token Method: POST (Fixed and cannot be changed)
Refresh Token Header: Default configuration
{"Content-Type":"application/x-www-form-urlencoded"}
Refresh Token Endpoint URL:
https://login.salesforce.com/services/oauth2/token
For detailed information, consult Salesforce documentation, as the endpoint URL may vary.
Refresh Token Endpoint Body
The following configuration keys are used in the request body:
- grant_type: Specifies the authentication grant type
- client_id: Unique identifier of the application
- client_secret: Confidential key for client authentication
- username: Username accessing the API
- password: Password associated with the username
These keys are used to securely exchange credentials and obtain an access token for protected API resources.
Note: API endpoint URLs may contain different placeholders. Users must enter all required values based on their configuration. Refer to Salesforce API documentation for details.
How to Configure / How to Use
After completing all required fields, endpoint URLs, SOQL queries, and OAuth configurations, users can validate and establish the connection to Salesforce.
Once validated, the configured source can be used in integration workflows.
Troubleshooting
If the Salesforce source configuration does not work as expected, verify the following:
- Ensure the domain name and API version are correct
- Confirm OAuth credentials are valid
- Verify SOQL query syntax
- Check refresh token endpoint settings
Frequently Asked Questions
What is required to configure Salesforce as a source?
Users must provide the Salesforce domain, API version, SOQL queries, and OAuth 2.0 credentials.
Which authentication method is used?
Salesforce uses OAuth 2.0 for API authentication.
Can custom business objects be queried?
Yes, custom objects can be queried using SOQL through the REST API.
Is coding required to configure Salesforce?
No, configuration can be completed using the platform interface and SOQL queries.
Where can I find OAuth credentials?
OAuth credentials are available in your Salesforce connected app configuration.
Notes
This guide is intended for users configuring Salesforce as a source using eZintegrations.
Only the steps and features described in this documentation are supported.
