Generate Bing Maps Api Key

Posted on by admin
-->

The Bing Maps Distance Matrix API provides travel time and distances for a set of origins and destinations. The distances and times returned are based on the routes calculated by the Bing Maps Route API. Times are based on predictive traffic information, depending on the start time specified in the request. Distance matrices can be calculated for driving, walking and public transit routes. This API can also generate distance matrices that optionally includes a histogram of travel times over a period of time with a set interval that takes into consideration the predicted traffic at those times.

May 23, 2016  All I can get out from the Map instance is the Bing Map keys using its Credentials property, which returns the string that is added in the XAML declaration of the Map instance. If someone could shed some light on how to acquire the relevant SessionID using Bing Maps Windows Store API. How would I use Bing Map API in my python program to generate a string of directions? It is kind of like this: longitude = -122.019943 latitude = 37.285989 destination = '1427 Alderbrook Ln San Jose CA 95129' # Some Bings Map API Magic that generates directions in a string print directions.

  • Dec 07, 2017  Entering the maps API keys. Once you have the maps API key for your site, you need to enter it in Toolset settings. Go to the Toolset- Settings page and click the Maps tab. There, select which API you want to use and enter the API key.
  • Sep 28, 2015  There is no need to protect your key. Anyone can create one and get access to the Bing Maps API. If there is suspicion of abuse of a key we have the ability to track back the usage. To date there has been cases of anyone stealing someone else's key. The only cases where people used other peoples key to date where due to those people providing.

Distance matrices are used in several different types of applications. The most common is to power algorithms which solve the Travelling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). Some other common applications include:

  • Sorting search results by their actual travel distance or time.
  • Determine arrival times based on travel times.
  • Calculate the difference in commute times between locations. For example: We are looking to move to a new office, what is the impact on commute times for our staff?
  • Clustering data based on travel time and distances. For example: Find all homes that are within 1 mile of a corner store.

When you make a request by using one of the following URL templates, the response returns a Distance Matrix resource that contains either an array of Distance Matrix cells or information on the asynchronous request that was made to calculate a distance matrix. Each distance matrix cell contains the location and index of the origin and destination it is related to, the travel time, and distance. If a distance matrix histogram is requested, a departure time for when in the histogram the cell it is related to will be included. For more information about the Distance Matrix resource, see Distance Matrix Data. You can also view the example URL and response values in the Examples section.

For Calculate a Distance Matrix geographic availability, see the travelMode parameter below.

API Limits

Requests to the distance matrix API can be done in one of two ways:

  • Most requests can be made with a simple synchronous GET or POST request.
  • (PREVIEW) More complex driving related requests which take longer to process, such as calculating a histogram of travel times and distances for each cell of a matrix, can be made by making an asynchronous Distance Matrix request. This type of request is only accepted when the travel mode is set to driving and a start time has been specified.

A distance matrix can be requested that has up to 2500 origins-destinations pairs which is calculated by multiplying the number of origins, by the number of destinations. For example, you can have 1 origin, and 2500 destinations, or 50 origins and 50 destinations.

A histogram of travel times and distances can be requested but is limited to a distance matrix that has a maximum of 100 origins-destinations pairs when the request is made asynchronously, and 10 origins-destinations pairs when made synchronously. The maximum time interval between the start and end time when calculating a distance matrix histogram is 24 hours.

When to use synchronous vs asynchronous requests

Make synchronous request if the travel mode is driving, walking or transit and:

  • The total number of origins-destinations pairs is less than or equal to 2500 and no start time is specified.

or

  • The travel mode is for driving, the number of origins-destinations pairs is less than or equal to 10 and a start time is specified, but not an end time. This will simply return a single cell for each origin-destination pair that is calculated using predictive traffic data.

Make an Asynchronous request if the travel mode is for driving, a start time is specified and:

  • The number of origins-destinations pairs is less than or equal to 100, a start time and an end time is specified.

If your scenario doesn’t fit either of the parameters outlined above for synchronous and asynchronous requests, you will need to break your request up into smaller chunks. Note that transactions are based on the total number of cells in the resulting matrix and not on the number of requests, so the same number of transactions would be generated if you make two requests that generate 100 cells each or 1 request that generates 200 cells.

Bing Maps Api Basic Key

How asynchronous requests work

See Asynchronous Requests documentation.

How to calculate number of cells a response will have

When calculating a simple distance matrix each origin-destination pair will generate a single cell in the matrix.

For example, a matrix that has 2 origins, and 5 destinations, will generate 10 cells where 2 * 5 = 10.

When a matrix includes a histogram, each origin-destination pair will have a cell in the matrix for each time interval. The number of time intervals that a request will have depends on the resolution, start and end times.

For example, a matrix that has 2 origins, 5 destinations, and retrieves time intervals in 15-minute increments (resolution = 1) over 24 hours, will generate 960 cells where 2 * 5 * 24/0.25 = 2 * 5 * 24 * 4 = 960.

Note

Cells will not be generated for origin-destination pairs that have the same index and coordinate. These will not be included in the transaction counts. If these exist in your query, you can subtract these from the calculated number of cells above to get a more accurate number for estimating transaction counts.

How to calculate total number of billable transactions a request will generate

A billable transaction is generated for every 4 cells in a matrix, rounded up to the nearest whole integer. For a simple matrix, billable transactions will be calculated using the following formula:

For example, a matrix that has 2 origins, and 5 destinations, will generate 3 billable transactions where Ceiling(0.25 * 2 * 5) = 3.

When calculating a matrix which includes a histogram, only the first 30 time intervals in each origin-destination pair are counted towards billable transactions, any additional time intervals are provided for free.

For example, a matrix that has 2 origins, 5 destinations, and retrieves time intervals in 15 minute increments (resolution = 1) over 24 hours, will generate 75 cells where Ceiling(0.25 * 2 * 5 * Min(30, 24/0.25)) = Ceiling(0.25 * 2 * 5 * Min(30, 96)) = Ceiling(0.25 * 2 * 5 * 30) = 75. Note that 24/0.25 = 24 * 4 = 96, but since only the first increments per origin-destination pair is counted towards billable transaction, 66 time intervals are excluded from the transaction calculation per origin-destination pair, thus saving you a total of 165 billable transactions in this scenario.

Supported HTTP Methods

GET, POST

POST requests require all parameters to be passed into the body of the request as a JSON object. This API is CORs enabled.

When to use HTTP GET vs POST

Many developers prefer the simplicity of HTTP GET requests which simply require generating a URL. However, browsers and servers have limits on the maximum length that URLs can be. Typically, it is best to keep your URLs under 2083 characters in length. With this in mind, it is recommended to only use HTTP GET requests when your request has less than a total of 50 origins and destinations.

URL Template

Note

These templates support both HTTP and HTTPS protocols.To use this API, you must have a Getting a Bing Maps Key.

Synchronous Distance Matrix Request URL (GET)

Retrieves a simple distance matrix for a set of origins and destinations using a HTTP GET request.

Synchronous Distance Matrix Request URL (POST)

Retrieves a simple distance matrix for a set of origins and destinations using a HTTP POST request.

HTTP POST Request URL

POST Header

POST body

Asynchronous Distance Matrix Request URL (GET)

Creates a job to calculate a distance matrix using an asynchronous GET request. This type of request is only supported when the travel mode is set to driving. A start time must be specified when making asynchronous requests.

Asynchronous Distance Matrix Request URL (POST)

Creates a job to calculate a distance matrix using an asynchronous POST request. This type of request is only supported when the travel mode is set to driving. A start time must be specified when making asynchronous requests.

HTTP POST Request URL

HTTP POST Header

HTTP POST body

URL for checking Asynchronous Request status (GET)

The initial asynchronous response includes a callbackUrl property which contains the URL that can be used to check the status of the job. Alternatively, the callback URL can also be generated by appending the requestId that is returned in the initial asynchronous request along with the same Bing Maps key used, with the DistanceMatrixAsyncCallback endpoint as shown below. The response from this request will indicate if the request is complete or not, if complete it will provide a resultUrl property which is a URL that can be used to download the results.

Template Parameters

Note

Additional parameters, such as output and JSON callback parameters, are found in Output Parameters.

ParametersDescription
originsRequired. List of origins described as coordinate pairs with latitudes and longitudes. The format of each coordinate pair must use one of the following formats:
For GET requests: lat0,lon0;lat1,lon1;...;latM,lonM
Example: origins=37.77916,-122.42;32.71568,-117.16172
For POST requests:
[
{
'latitude': lat0,
'longitude': lon0
},
{
'latitude': lat1,
'longitude': lon1
},
.
.
.
{
'latitude': latN,
'longitude': lonN
}
]
Example:
'origins': [
{
'latitude': 37.77916,
'longitude': -122.42
},
{
'latitude': 32.71568,
'longitude': -117.16172
}
]
destinationsOptional. List of destinations described as coordinate pairs with latitudes and longitudes. If not specified, an n x n matrix will be generated using the origins. The format of each coordinate pair must have the following format:
For GET requests: lat0,lon0;lat1,lon1;...;latM,lonM
Example: destinations=37.77916,-122.42;32.71568,-117.16172
For POST requests:
[
{
'latitude': lat0,
'longitude': lon0
},
{
'latitude': lat1,
'longitude': lon1
},
.
.
.
{
'latitude': latN,
'longitude': lonN
}
]
Example:
'destinations': [
{
'latitude': 37.77916,
'longitude': -122.42
},
{
'latitude': 32.71568,
'longitude': -117.16172
}
]
travelModeRequired. Specifies the mode of transportation to use when calculating the distance matrix. Can be one of the following values:
• driving
• walking
• transit
Example: travelMode=driving
Geographic Availability:
- Driving is available in routing markets seen in the Geographic Coverage documentation with the exception of China, Japan, and Korea.
- Walking is available in North America (US, Canada, Mexico).
- Transit is available in markets seen in the Transit Coverage documentation.
startTimeOptional for Driving. Specifies the start or departure time of the matrix to calculate and uses predictive traffic data. This should be a date string in a format that can be parsed by DateTimeOffset.Parse. This option is only supported when the travel mode is set to driving.
Example: startTime=2017-06-15T8:00:00-07:00
endTimeOptional for Driving. If specified, a matrix based on traffic data with contain a histogram of travel times and distances for the specified resolution intervals (default is 15 minutes) between the start and end times. A start time must be specified for the request to be valid and the total time between start and end cannot be greater than 24 hours. This should be a date string in a format that can be parsed by DateTimeOffset.Parse. This option is only supported when the travel mode is set to driving.
Example: endTime=2017-06-15T13:00:00-07:00
resolutionOptional for Driving. The number of intervals to calculate a histogram of data for each cell where a single interval is a quarter of an hour. Can be one of the following values:
• 1 - 15 minutes
• 2 - 30 minutes
• 3 - 45 minutes
• 4 - an hour
If start time is specified and resolution is not, it will default to an interval of 1 (15 minutes).
Example: resolution=2
distanceUnitOptional. The units to use for distances in the response. One of the following values:
• mile or mi
• kilometer or km [default]
Example: distanceUnit=mi
timeUnitOptional. The units to use for time durations in the response. One of the following values:
• minute [default]
• second
Example: timeUnit=second

Tip

Geocode your origins and destinations ahead of time and store that information if you plan to use those locations in future requests. The Bing Maps terms of use allow the geocode result data to be stored for as long as you have a Bing Maps license. This can help speed up future requests and reduce transactions as geocoding of origin and destinations won’t be needed.

Response

A DistanceMatrix resource is returned when you make a request with one of the following URLs. For more information about the DistanceMatrix resource, see Distance Matrix Data. For more information about the common response syntax for the Bing Maps REST Services, see Common Response Description. JSON and XML responses are provided for the URL examples in the following section.

These URLs support JSON (application/json) and XML (application/xml) response formats. A JSON response is provided by default unless you request XML output by setting the output (o) parameter. For more information, see Output Parameters.

Examples

All examples include a GET and its equivalent POST and will use the following set of origins and destinations.

Origins:

  • Seattle, WA (47.6044, -122.3345)
  • Redmond, WA (47.6731, -122.1185)
  • Bellevue, WA (47.6149, -122.1936)

Destinations:

  • Portland, OR (45.5347, -122.6231)
  • Renton, WA (47.4747, -122.2057)

Calculate a simple driving based Distance Matrix (synchronous)

The following example shows how to request a simple driving based distance matrix for the set of origins and destinations. To view the complete XML and JSON responses, see Distance Matrix Example.

HTTP GET Request URL

HTTP POST Request URL

Bing Developer Api Key

HTTP POST Header

HTTP POST Body

Calculate a simple driving based Distance Matrix for specific time (synchronous)

The following example shows how to request a simple driving based distance matrix for the set of origins and destinations for a specified time, June 15th, 2017 at 1PM PST. This request will automatically use predictive traffic data to provide accurate estimates.

HTTP GET Request URL

HTTP POST Request URL

HTTP POST Header

HTTP POST Body

Calculate a simple driving based Distance Matrix for specific time (asynchronous)

The following example shows how to request a simple driving based distance matrix for the set of origins and destinations for a specified time, June 15th, 2017 at 1PM PST. This request will automatically use predictive traffic data to provide accurate estimates. To view the complete XML and JSON responses, see Distance Matrix Asynchronous Example.

HTTP GET Request URL

HTTP POST Request URL

HTTP POST Header

HTTP POST Body

Once the initial request is made a requestId will be returned. A requestId is a unique identifier for the asynchronous request. This can be used to monitor the status of the request until it is completed, at which point the response will include a resultUrl property which the resulting distance matrix can be downloaded from. The following URL checks that status of an asynchronous request that has a requestId of 90b07189-33d8-4cbf-866a-1bd5c5b4f474.

Calculate a driving based Distance Matrix Histogram (asynchronous)

The following example shows how to request a driving based distance matrix histogram for the set of origins and destinations between June 15th, 2017 at 1PM PST and June 15th, 2017 at 5PM PST with a resolution of 2 (30-minute intervals). This request will automatically use predictive traffic data to provide accurate estimates. To view the complete XML and JSON responses, see Distance Matrix Histogram Example.

HTTP GET Request URL

HTTP POST Request URL

HTTP POST Header

HTTP POST Body

Once the initial request is made a requestId will be returned. A requestId is a unique identifier for the asynchronous request. This can be used to monitor the status the request until it is completed, at which point the response will include a resultUrl property which the resulting distance matrix histogram can be downloaded from. The following URL checks that status of an asynchronous request that has a requestId of 90b07189-33d8-4cbf-866a-1bd5c5b4f474.

HTTP Status Codes

Note

For more details about these HTTP status codes, see Status Codes and Error Handling.

When the request is successful, the following HTTP status code is returned.

  • 200

When the request is not successful, the response returns one of the following errors.

  • 400
  • 401
  • 404
  • 429
  • 500
  • 503

See Also

New Users: Before you can start using the Google Maps Platform APIs and SDKs, you must sign up and create a billing account.To learn more, see Get Started with Google Maps Platform.

Generate Bing Maps Api Key Android

To use the Maps Embed API you must have an API key. The API key is a unique identifier that isused to authenticate requests associated with your project for usage and billing purposes.

Get the API key

You must have at least one API key associated with your project.

To get an API key:

  1. Visit the Google Cloud Platform Console.
  2. Click the project drop-down and select or create the project for which you want to add an API key.
  3. Click the menu button and select APIs & Services > Credentials.
  4. On the Credentials page, click Create credentials > API key.
    The API key created dialog displays your newly created API key.
  5. Click Close.
    The new API key is listed on the Credentials page under API keys.
    (Remember to restrict the API key before using it in production.)

Add the API key to your request

Bing Maps Api Key Free

You must include an API key with every Maps Embed API request.In the following example, replace YOUR_API_KEY withyour API key.

For more information about MODE and parameters options in the code above, see Forming the URL for the Maps Embed API.

Restrict the API key

We strongly recommend that you restrict your API key. Restrictions provide added security and helpensure only authorized requests are made with your API key. There are two restrictions. You shouldset both:

  • Application restriction: Limits usage of the API key to either websites (HTTP referrers), web servers (IP addresses), or mobile apps (Android apps or iOS apps). You can select only one restriction from this category, based on the platform of the API or SDK (see GMP APIs by Platform).

    Note: If you need to call web, web service, and/or mobile APIs from the same (client-side) app, create and restrict multiple keys.

  • API restriction: Limits usage of the API key to one or more APIs or SDKs. Requests to an API or SDK associated with the API key will be processed. Requests to an API or SDK not associated with the API key will fail. (The API or SDK must be enabled and must support the application restriction.)

To restrict an API key:

  1. Go to the Google Cloud Platform Console.
  2. Click the project drop-down select the project that contains the API key you want to secure.
  3. Click the menu button and select APIs & Services > Credentials.
  4. On the Credentials page, click the name of the API key that you want to secure.
  5. On the Restrict and rename API key page, set the restrictions:
    • Application restrictions
      • Select HTTP referrers (web sites).
      • Add the referrers.
    • API restrictions
      • Select Restrict key.
      • Click Select APIs and select Maps Embed API.
        (If the Maps Embed API is not listed, you need to enable it.)
    • Click SAVE.