Salesforce & Bing API Distance Calculator
Total Travel Distance
What is a Distance Calculation Using Bing API in Salesforce?
A distance calculation using Bing API in Salesforce is a process where Salesforce, a customer relationship management (CRM) platform, communicates with Microsoft’s Bing Maps API to determine the travel distance and time between two or more geographical locations. This is typically done to enhance business processes within Salesforce, such as optimizing sales routes, calculating shipping costs, or managing field service appointments. Instead of relying on simple straight-line distance, which is often inaccurate for real-world travel, this method provides actual driving, walking, or transit-based distances.
This integration is most commonly achieved by making an ‘API callout’ from Salesforce’s backend using Apex code. The Salesforce code sends the origin and destination addresses (often stored on Account or Contact records) to the Bing Maps API, which then processes the information and returns detailed route data, including the total distance and estimated duration.
The “Formula” for a Salesforce to Bing API Callout
While not a simple mathematical formula, the process of a distance calculation using Bing API in Salesforce follows a structured API request. The core component is an HTTP callout to the Bing Maps Routes API endpoint. The “formula” is the structure of this request URL.
A simplified version of the API request endpoint looks like this:
http://dev.virtualearth.net/REST/v1/Routes/Driving?wayPoint.1=ORIGIN&wayPoint.2=DESTINATION&key=YOUR_API_KEY
In a real Salesforce implementation, this request is built and executed using Apex’s HttpRequest class. The results, typically in JSON format, are then parsed to extract the key values.
| Variable | Meaning | Unit / Type | Typical Range |
|---|---|---|---|
wayPoint.1 |
The starting address or latitude/longitude coordinates. | Text String | e.g., “123 Main St, Anytown, USA” |
wayPoint.2 |
The ending address or latitude/longitude coordinates. | Text String | e.g., “456 Oak Ave, Otherville, USA” |
travelMode |
The method of transport (Driving, Walking, Transit). | Text String | ‘Driving’, ‘Walking’, ‘Transit’ |
key |
Your unique Bing Maps API authentication key. | Text String (Alphanumeric) | Provided by Microsoft. |
distanceUnit |
The desired unit for the distance result. | Text String | ‘km’ (Kilometer), ‘mi’ (Mile) |
For more advanced scenarios, check out the official Bing Maps documentation.
Practical Examples
Example 1: Field Sales Route Optimization
A sales manager wants to find the travel time between two key accounts for a field agent.
- Inputs:
- Origin: Account A’s Billing Address (in Salesforce)
- Destination: Account B’s Billing Address (in Salesforce)
- Travel Mode: Driving
- Process: An Apex trigger on a custom “Trip” object initiates a callout to the Bing API.
- Results:
- Distance: 45.2 miles
- Time: 1 hour 15 minutes (with traffic)
Example 2: Service Appointment Confirmation
A service company wants to automatically calculate the distance to a customer’s site to estimate arrival time.
- Inputs:
- Origin: Technician’s current location (from Salesforce mobile)
- Destination: Customer’s Shipping Address on the Case record
- Travel Mode: Driving
- Process: A Salesforce Flow calls an Apex action to perform the Bing API callout.
- Results:
- Distance: 12.5 km
- Time: 22 minutes
To implement this yourself, you can read more about Salesforce & Bing Maps Integration techniques.
How to Use This Distance Calculation Simulator
This calculator simulates the inputs and outputs of a real Salesforce and Bing API integration.
- Enter API Key: Input your Bing Maps API key. For this simulation, you can leave the default value. A real key is required for a production environment.
- Define Addresses: Type in the full origin and destination addresses.
- Select Travel Mode: Choose between Driving, Walking, or Public Transit.
- Choose Units: Select whether you want the results in Imperial (miles) or Metric (kilometers).
- Calculate: Click the “Calculate Distance” button. The tool will simulate the API call and display the estimated distance and travel time.
- Interpret Results: The main result is the distance. Intermediate values like travel time and a simulated API status provide more context.
| Parameter | Value |
|---|---|
| Origin | — |
| Destination | — |
| Distance (Miles) | — |
| Distance (KM) | — |
| Travel Time | — |
Key Factors That Affect Distance Calculation Using Bing API in Salesforce
- API Key Validity: An invalid or expired Bing Maps API key will cause all requests to fail.
- Address Quality: Inaccurate or incomplete addresses in your Salesforce records are a primary cause of calculation errors. Marker plotting can be incorrect if house numbers are missing.
- Salesforce Callout Limits: Salesforce has limits on the number of external API calls (callouts) you can make in a given period. Bulk processing of records requires careful design, such as using batch Apex.
- API Usage Costs: The Bing Maps API is a paid service with different tiers. High-volume calculations can incur significant costs, which need to be monitored.
- Travel Mode Selection: The chosen travel mode (Driving, Walking, Transit) dramatically changes the distance and time results.
- Time of Day: For driving routes, the Bing Maps API can use predictive traffic data, meaning a request made for 8 AM will yield a different travel time than one for 3 PM.
Frequently Asked Questions (FAQ)
- 1. Does Salesforce have a built-in distance calculation?
- Yes, Salesforce provides a `DISTANCE()` function for formulas. However, it calculates straight-line (“as the crow flies”) distance, not actual road travel distance, making it unsuitable for most routing logistics.
- 2. Is a Bing Maps API key free?
- Bing Maps offers a free basic key for development and testing purposes, but a paid enterprise key is required for most large-scale business applications.
- 3. Why is my distance calculation failing?
- Common reasons include an invalid API key, poorly formatted addresses, not adding the Bing Maps URL to Salesforce’s Remote Site Settings, or exceeding API callout limits.
- 4. Can I calculate the distance for hundreds of records at once?
- Yes, but it must be done carefully using asynchronous Apex, like a Batch class, to avoid hitting Salesforce governor limits on callouts. The Bing Maps Distance Matrix API is designed for these many-to-many scenarios.
- 5. What is a “callout” in Salesforce?
- A callout is when Apex code makes a request to an external web service, like the Bing Maps API, to send or retrieve information.
- 6. How do I handle addresses that can’t be found (geocoded)?
- Your Apex code should include error handling to manage responses where the API cannot find a valid location for an address, logging the error against the Salesforce record for data cleanup. Some common issues include markers plotting in the middle of a street if a house number isn’t found.
- 7. Can I use Google Maps instead of Bing Maps?
- Yes, the same principles apply. You would make a callout to the Google Maps API instead, which has its own specific endpoints and key requirements. The choice often depends on licensing costs and feature preferences.
- 8. Is the Bing Maps Distance Matrix API being retired?
- Yes, the Bing Maps Distance Matrix API is being deprecated and will be retired for Enterprise customers by June 30th, 2028. Users are advised to migrate to the Azure Maps Route Matrix API.
Related Tools and Internal Resources
Explore other powerful integration and automation tools:
- Salesforce Automation Tools: Discover tools for process automation.
- Apex Callout Best Practices: Learn how to make efficient and robust API calls from Salesforce.
- Visualforce Mapping Components: Guides on embedding maps directly into your Salesforce UI.
- API Integration Cost Analysis: A look at how to budget for third-party API usage.
- CRM Data Cleansing Strategies: Improve the quality of your address data for better geocoding results.
- Azure Maps Migration Guide: A step-by-step guide for moving from Bing Maps to Azure Maps.