Geowidget International
- Michał Machowski
- Maciej Prucnal
Geowidget international is a locator and point selector designed by InPost.
Its key functions are:
Displaying a map with points of different types (e.g. parcel lockers, parcel points)
Providing information about these points and enabling integration with external systems of the clients
This is a widget type software. This means that all the code and processing takes place on InPost servers. External clients only attach a link to this code and specify the configuration that will be used in their systems.
Na tej stronie
Production Environment
Production environment address: https://geowidget.inpost-group.com
Generating access
Go to the Parcel Manager website https://manager.paczkomaty.pl
In the login window, enter your login and click: Login
After logging in go to My Account tab
In the Data tab check if all the company data is correctly filled in
Remember, in order to generate access to API, both company address and invoice data have to be filled in.
After verification go to the new tab API
To generate a new access to Geowidget expand the Geowidget tab and click Generate
Test Environment
Test environment address: https://sandbox-global-geowidget-sdk.easypack24.net/
Generating access
Go to the Parcel Manager website https://sandbox-manager.paczkomaty.pl
In the login window, enter your login and click: Login
After logging in go to My Account tab
In the Data tab check if all the company data is correctly filled in
Remember, in order to generate access to API, both company address and invoice data have to be filled in.
After verification go to the new tab API
To generate new access to Geowidget, expand the
Geowidget tab and click Generate
For a sandbox environment when using localhost, do not indicate the domain when generating the token.
Basic integration
To use the new version of the Geowidget, add the following lines to the page headers.
<link rel="stylesheet" href="https://sandbox-global-geowidget-sdk.easypack24.net/inpost-geowidget.css"/>
<script src='https://sandbox-global-geowidget-sdk.easypack24.net/inpost-geowidget.js' defer></script>
<script>
function afterPointSelected(point) { alert('Selected point: ' + point.name); }
</script>
And then embed the custom element in the selected place
<inpost-geowidget token='token-for-geo' country='NL,PL' language='pl' config='parcelcollect'></inpost-geowidget>
The parameters are described here The ‘country’ parameter takes the possible values given after the decimal point e.g. : PL,IT. The first value of the country code indicates the default location of the map when geolocation functionality is disabled on the device.
Complete integration
To use the new version of the geowidget, add the following lines to the page headers.
<link rel="stylesheet" href="https://sandbox-global-geowidget-sdk.easypack24.net/inpost-geowidget.css"/>
<script src='https://sandbox-global-geowidget-sdk.easypack24.net/inpost-geowidget.js' defer></script>
<script>
document.addEventListener('onpointselect', (event) => alert(event.details.name));
</script>
And then embed the custom element in the selected place
The parameters are described here
Example how to call api method
Description of each parameter:
Parameter | Description |
|---|---|
| The parameter takes the function / name to be performed after selecting a point on the map. |
| Parameter to pass the PUBLIC token generated in the package manager application:
Generating access
|
| A parameter that allows to define the default language of the widget - optional.
If the user has already used the new version of the Geowidget - the interface will be displayed in the language he used previously. |
| A parameter that defines which functions / types are to have the points displayed on the map (values are described in the table below). |
| The
The first value of the country code indicates the default location of the map when geolocation functionality is disabled on the device. |
Configuration options:
Description | Option | functions | Type of points presented | Country |
|---|---|---|---|---|
Display collection points for prepaid orders |
| parcel_collect | Parcel Locker, ParcelPoint | all countries |
Display collection points for cash on delivery orders |
| parcel_collect | Parcel Locker, ParcelPoint | PL |
Display collection points for Weekend shipments |
| parcel_collect | Parcel lockers and ParcePoints available 24/7 | PL |
Showing sending points |
| parcel_send | Parcel Locker, ParcelPoint | PL |