Add new geocoding provider: Bing (Locations API)

[Raruto]

Depends on:

• ✨ Add new geocoding provider: Bing g3w-admin#646
• Add marker feature to editing layer [g3w-client PR#505] g3w-client-plugin-editing#72

Premise

1. As per 2023/10 Bing Local Search API supports searches for business entities only in the USA.
2. Dynamic field mapping is currently not supperted while saving geocoding results into a project layer (ie. target layers must have the same field names as the resulting geocoding fields to work correctly, see: available bing attributes and sample target editable layer).
3. autogenerated fields (which do not collide with each other) are also mappable without using the provider prefix (and using lower case notation), eg:
   • bing_Website → website
   • bing_Address_postalCode → address_postalcode
   • bing_Address_locality → address_locality

Docker settings

# config/g3w-suite/settings_docker.py

VENDOR_KEYS = {
 'bing': 'your.super.secret.key'
}

GEOCODING_PROVIDERS = {
  "nominatim": {
    "label": "Nominatim (OSM)",
    "url": "https://nominatim.openstreetmap.org/search",
    # "icon": "road",
  },
  "bing_streets": {
    "label": "Bing Streets",
    "url": "https://dev.virtualearth.net/REST/v1/Locations/?key=" + VENDOR_KEYS['bing'], # + '&inclnb=1',
    # "icon": "road",
  },
  "bing_places": {
    "label": "Bing Places",
    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/?key=" + VENDOR_KEYS['bing'],
    # "icon": "poi",
  },
}

To set a vendor key you can do as is most comfortable for you, e.g.:

• ?key=" + VENDOR_KEYS['bing'] ← passing it directly into the url
• VENDOR_KEYS['bing'] = "super.secret.key" ← setting a generic global key
• VENDOR_KEYS['bing_search'] = "super.secret.key" ← setting a specific key to that service

If you would like to add new providers (or rename existing ones), just remember to use the file name as "provider" identifier:

http://localhost:8000/static/client/geocoding-providers/bing_streets.js
http://localhost:8000/static/client/geocoding-providers/bing_places.js
http://localhost:8000/static/client/geocoding-providers/nominatim.js
http://localhost:8000/static/client/geocoding-providers/my_custom_provider.js
...

# config/g3w-suite/settings_docker.py

GEOCODING_PROVIDERS = {
  "bing_streets": { ... },
  "bing_places":  { ... },
  "nominatim":    { ... },
  "my_custom_provider": {
    "label": "Custom Provider",
    "url": "https://example.com/search"
  },
}

VENDOR_KEYS['my_custom_provider'] = 'super.secret.key' 

How to test

1. download demo-geocoding.zip and create a new project within g3w-admin
2. set all point layers as editable
3. perform a geocoding search (eg. cafe)

Add new feature from geocoding results (bing or nominatim)

Available attributes (bing)

Available attributes (nominatim)

Sample QGIS layer (target editable point layer)

Closes: #498

[Raruto]

@wlorenzetti @volterra79 you can update your docker settings as follows to test:

# config/g3w-suite/settings_docker.py

VENDOR_KEYS = {
 'bing': 'your.super.secret.key'
}

GEOCODING_PROVIDERS = {
  "nominatim": {
    "label": "Nominatim (OSM)",
    "url": "https://nominatim.openstreetmap.org/search",
    # "icon": "road",
  },
  "bing_streets": {
    "label": "Bing Streets",
    "url": "https://dev.virtualearth.net/REST/v1/Locations/?key=" + VENDOR_KEYS['bing'], # + '&inclnb=1',
    # "icon": "road",
  },
  "bing_places": {
    "label": "Bing Places",
    "url": "https://dev.virtualearth.net/REST/v1/LocalSearch/?key=" + VENDOR_KEYS['bing'],
    # "icon": "poi",
  },
}

To set a vendor key you can do as is most comfortable for you, e.g.:

• ?key=" + VENDOR_KEYS['bing'] ← passing it directly into the url
• VENDOR_KEYS['bing'] = "super.secret.key" ← setting a generic global key
• VENDOR_KEYS['bing_search'] = "super.secret.key" ← setting a specific key to that service

If you would like to add new providers (or rename existing ones), just remember to use the file name as "provider" identifier:

http://localhost:8000/static/client/geocoding-providers/bing_streets.js
http://localhost:8000/static/client/geocoding-providers/bing_places.js
http://localhost:8000/static/client/geocoding-providers/nominatim.js
http://localhost:8000/static/client/geocoding-providers/my_custom_provider.js
...

# config/g3w-suite/settings_docker.py

GEOCODING_PROVIDERS = {
  "bing_streets": { ... },
  "bing_places":  { ... },
  "nominatim":    { ... },
  "my_custom_provider": {
    "label": "Custom Provider",
    "url": "https://example.com/search"
  },
}

VENDOR_KEYS['my_custom_provider'] = 'super.secret.key'