Constructing a request

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

Element Value/Example Description
Base URL https://geofencing.hereapi.com authenticate via apiKey, see Identity & Access Management Developer Guide.
Path /v8/
Resource ```language-javascript

/v8/geofence


 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](supported-resources.md)|
|Format|Supported formats:

-   `.json`

| |
|API Key|`&apiKey=\{YOUR\_API\_KEY\}`|Substitute your own unique `apikey`. For more information, see the [Identity & Access Management Developer Guide](https://developer.here.com/documentation/identity-access-management/dev_guide/index.html).|
|Application Code|`&app_code=\{YOUR\_APP\_CODE\}`|Substitute your own unique `app_code`. For more information, see the [Identity & Access Management Developer Guide](https://developer.here.com/documentation/identity-access-management/dev_guide/index.html).|
|Application Id|`&app_id=\{YOUR\_APP\_ID\}`|Substitute your own unique `app_id`. For more information, see the [Identity & Access Management Developer Guide](https://developer.here.com/documentation/identity-access-management/dev_guide/index.html).|

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

```language-html
https://geofencing.hereapi.com/v8/geofence
?apiKey=\{YOUR\_API\_KEY\}
&layer_ids=123
&key_attribute=NAME
&proximity=39.1066,-94.61,500

Note: This example uses a HERE API Key to authenticate your request. For the available authentication options, see the Identity & Access Management Developer Guide.

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))

results matching ""

    No results matching ""