Skip to Content
GeocodingHow-to guidesSet up the provider

Set up the provider

For: platform owners. Setup: ModularIoT (the web application at modulariot.com/app).

The platform contracts a geocoding provider and pays for it. Each organization uses it through a connection that a platform owner creates. This guide gets the provider ready and connects an organization.

StepWhereSelector scope
1. Store the provider’s tokenSettings › CredentialsPlatform
2. Choose the providerSettings › ConnectionsPlatform
3. Connect the organizationSettings › ConnectionsThe organization
4. Give it a quotaSettings › Platform › GeocodingAny

You change the scope in the organization selector, at the top right. Platform is the first option in the list and only platform owners see it.

Store the provider’s token

  1. Change the selector to Platform.
  2. Open Settings › Credentials and click Add credential.
  3. Search for map and choose Mapbox or Google Maps.
  4. Paste the token and save.

Mapbox and Google Maps credential types

Use a Mapbox server token, without URL restrictions, with permanent mode enabled in your Mapbox account. The token is not shown again.

Choose the provider

  1. With the selector on Platform, open Settings › Connections.
  2. If the Platform geocoding card exists, click its three dots and Edit. If not, click New connection and choose Geocoding · platform provider.
  3. Fill in the form and click Save.

Platform geocoding provider form

FieldWhat to enter
ProviderMapbox
CredentialThe one from step 1
Permanent modeOn. Without it, no provider result is used: all go to review
Our cost per call (USD)What the provider charges per call in permanent mode, under its contract, for example 0.005. It is copied into each usage row. It is not what the organization pays

Pitfall: with Google Maps as the provider, each call is charged and the place goes to review, because the platform does not store Google results (default setting, pending a review of its terms). Use Mapbox with permanent mode.

With Mapbox, saving checks the token at no cost and the card turns Active. Google is not tested on save: Test geocodes an address and the provider charges for it. The card’s status does not block calls.

Connect the organization

  1. Change the selector to the organization.
  2. Open Settings › Connections and click New connection.
  3. Choose Geocoding · platform provider.

New connection picker with the geocoding option

The Geocoding · ModularIoT card appears, active:

Geocoding · ModularIoT connection card in an organization

The connection stores no token: it uses the platform’s. Repeating the step does not create another one. If the organization had another geocoding connection, it is deleted.

Without this connection, the organization still resolves by geofence, Plus Code, coordinates, internal addresses and cache. The only thing it does not do is call the provider: those places go to review with geocoding: this organization has no geocoding connection; a platform owner adds it in Settings › Connections.

To remove it, click its three dots and Delete.

Give it a quota

If the quotas apply, the organization needs a subscription. Follow Assign an organization’s quota.

Check

Resolve an address that is not in the internal addresses or in the cache (see Your first location) and open Settings › Trips › Monthly usage. The Quota card must add one call. If the provider did not find the address, the call appears in the None or Provider row with the result To review.

Through the API

StepCall
2PUT /api/v1/platform/geocoding-provider with provider, credentialProfileId, permanent, costPerRequestUsd
3POST /api/v1/platform/orgs/{slug}/geocoding-connection

Details in Plan, usage and provider API.

Last updated on