Geofencing Extension API Developer's Guide

Constructing a Request

A typical request to the Geofencing Extension API includes the basic elements shown in the following table and, in addition, it may contain resource-specific parameters or data.

Table 1. Basic request elements
Element Value/Example Description
Base URL

https://gfe.api.here.com

https://gfe.cit.api.here.com

https://maps.gfe.api.here.com

https://maps.gfe.cit.api.here.com

Production environment

CIT environment

maps environment (uses map layers instead of customer-defined layers)

For more information about the available environments, see HERE Server Environments.

Path /2/  
Resource
/2/search/proximity.json
Use the CLE resources to manage geofence layers

Query which geofence geometries of a certain layer cover or are close to the given asset position.

GET only, specify request details via query parameters

One of the resource names supported by the service, see Supported Resources

Format
Supported formats:
  • .json
 
Application Code &app_code={YOUR_APP_CODE} Substitute your own unique app_code
Application Id &app_id={YOUR_APP_ID} Substitute your own unique app_id

This example request uses HTTP GET to check if an asset is inside or outside of a particular geofence polygon.

https://gfe.cit.api.here.com/2/search/proximity.json
  ?app_id={YOUR_APP_ID}
  &app_code={YOUR_APP_CODE}
  &layer_ids=123
  &key_attribute=NAME
  &proximity=39.1066,-94.61,500
Note: The above example assumes you have uploaded the following WKT file to the service.
ID    NAME     ABBR   WKT
1     Kansas   KS     POLYGON((-102.0 40.0,-102.0 37.0,-94.619 37.0,-94.619 39.1074,-95.310 40.0))