Mapia STREETS API (v3)
Documentation of MapiaSTREETS version 3 APIs. These APIs are used in the Mapia STREETS module of the Mapia Server and are utilized in integrations of Mapia STREETS (Geoportal, plugins, etc.).
Information
All APIs return data in JSON format.
Configurations API
API to access all system configurations.
If no parameter is specified, the API returns all configurations.
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/plugins/mapiastreets/api/config/
| Parameter | Name | Description |
|---|---|---|
| n | Variable name | Returns the configuration for the specified variable |
Result: All information of the object.
Zones API
API to access and retrieve information about zones.
If no parameter is specified, the API returns all zones.
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/plugins/mapiastreets/api/zone/
| Parameter | Name | Description |
|---|---|---|
| id | Zone ID | Returns the zone with the specified ID |
| epsg | EPSG code | Code with which to return geographic data |
Result: All information of the object.
Campaigns API
API to access and retrieve information about campaigns.
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/plugins/mapiastreets/api/campaing/
If no parameter is specified, the API returns all campaigns.
| Parameter | Name | Description |
|---|---|---|
| id | Campaign ID | Returns the campaign with the specified ID |
| z | Zone ID | Returns all campaigns of the zone |
| epsg | EPSG code | Code with which to return geographic data |
Result: All information of the object and metadata information of each campaign.
Search API
API to retrieve all existing information at a given point.
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/plugins/mapiastreets/api/search/
| Parameter | Name | Description |
|---|---|---|
| p | Point | Coordinates of the point to be queried (lat,lng) |
| r | Radius | Search radius in meters. If omitted, the one defined in the configuration is used. Only affects POIs, point clouds are searched in a radius of 1 Km. |
| t | Tag | To retrieve only data with the specific tag |
| z | Zone ID | Filter by a specific zone |
| c | Campaign ID | Filter by a specific campaign |
| f | Filter | To retrieve only POIs or point clouds. Values: POI, PC |
| fpc | Format | Filter based on point cloud formats. All if omitted. Values: POTREE, POTREE2, LAS, POD. |
| fpp | POI Format | Filter based on the type of POI. All if omitted. Values: PANO, IMG, ELEVATION. |
| l | Is Local | true/false. Filter by is_local. All if omitted. |
| d | Is Downloadable | true/false. Filter by is_downloadable. All if omitted. |
| epsg | EPSG code | Code with which to return geographic data |
Result: All information of the POIs (panoramas, elevation points, etc.), point clouds, and resources (auxiliary images, etc.).
- POIs: within the specified radius and ordered by distance.
- Point clouds: those that contain the point.
- Resources: related to panoramas.
Points of Interest (POIs) API
API to access and retrieve information about points of interest.
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/plugins/mapiastreets/api/pano/
| Parameter | Name | Description |
|---|---|---|
| id | POI ID | Returns the POI with the specified ID |
| epsg | EPSG code | Code with which to return geographic data |
Result: All information of the POI and related resources.
| Parameter | Name | Description |
|---|---|---|
| id | Point Cloud ID | Returns the point cloud with the specified ID |
| z | Zone ID | Filter by a specific zone |
| c | Campaign ID | Filter by a specific campaign |
| epsg | EPSG code | Code with which to return geographic data |
Result: All information of the point cloud.
Virtual Tours API
API to access and retrieve virtual tours in point clouds.
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/plugins/mapiastreets/api/rc/
| Parameter | Name | Description |
|---|---|---|
| id | Point Cloud ID | Returns the point cloud with the specified ID |
| z | Zone ID | Filter by a specific zone |
| c | Campaign ID | Filter by a specific campaign |
| epsg | EPSG code | Code with which to return geographic data |
Result: All information of the point cloud.