EMBEDED API Documentation
The EMBEDDED API makes it simple to insert a map in a web page. Just add an iframe to the page, and use the following URL in the SRC attribute:
http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic
This URL accepts the following parameters:
| Name | Description | Posible values | Default value |
| view | Specify the type of map to use | {map, ortho, picto} | ortho |
| width | embbeded map width | int | |
| height | embbeded map height | int | |
| orientation | This is done using the view=picto parameter. It indicates which of the 4 available pictometry views should be used. | ||
| lon | Longitude in the Mercator projection format | float | |
| lat | Latitude in the Mercator projection format | float | |
| zoom | This value indicates the zoom level to be applied to the map | (0..19) | |
| show_zoom_bar | Controls whether or not to show the zoom and navigation controls | {true, false} | false |
| text | Displays text in a popup anchored at the longitude and latitude specified in the lon and lat parameters | ||
| background | Specify the type of background map to use | {osm, googlemaps-normal, googlemaps-satellite, yahoomaps-reg, yahoomaps-sat, microsoftmaps-road, microsoftmaps-aerial} | osm |
Examples:
Basic map
<iframe src="http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic" frameborder="0" width="450" height="350"></iframe>
Map with zoom and navigation controls
<iframe src="http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic?show_zoom_bar=true" frameborder="0" width="450" height="350"></iframe>
Map with zoom and navigation controls using the "map" view
<iframe src="http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic?show_zoom_bar=true&view=map" frameborder="0" width="450" height="350"></iframe>
Map with zoom and navigation controls, positioned at latitude: 43.28461, longitude: -2.170486
<iframe src="http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic?show_zoom_bar=true&lon=-2.170486&lat=43.28461" frameborder="0" width="450" height="350"></iframe>
Map with zoom and navigation controls, positioned at latitude: 43.28461, longitude: -2.170486, and a zoom level of 18.
<iframe src="http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic?show_zoom_bar=true&lon=-2.170486&lat=43.28461&zoom=18" frameborder="0" width="450" height="350"></iframe>
Map positioned at latitude: 43.32478, longitude: -1.978784 with text
<iframe src="http://b5m.gipuzkoa.eus/api/1.0/en/embedded/basic?lat=43.32478&lon=-1.978784&zoom=16&text=%3Cstrong%3EKursaal%3C/strong%3E%3Cp%3EAv.%20Zurriola,%201%3Cbr%20/%3E20002%20Donostia-San%20Sebastian%3Cbr%20/%3ETel%C3%A9fono.%20+34%20943%2000%2030%2000%20-%20Fax:%20+34%20943%2000%2030%2001%3C/p%3E%3Cp%20style=%27text-align:center;%27%3E%3Ca%20href=%27http://www.kursaal.es%27%3Ewww.kursaal.es%3C/a%3E" frameborder="0" width="450" height="350"></iframe>
