Address search property
8 min
turn a json property into an address search field users start typing, pick an address from a live dropdown, and related fields (city, zip, country, coordinates…) are filled in automatically from a search provider of your choice how it works user types into the address field hyperportal queries your provider and shows matching suggestions the user selects one the chosen address is saved, and — if you configured a response mapping — its parts are copied into other properties of the same item some providers return everything in one call others use two steps a first call returns suggestions with an internal id, and a second call fetches the full details for the selected suggestion both are supported setup step 1 create a search service go to settings → apps → 3rd party search and add an instance authentication choose how your provider is accessed none — the provider needs no key optionally enable route requests through hyperportal if the provider can’t be called directly from the browser api key — paste your key and choose where it goes as a query parameter or a header, and its name (e g apikey, key, or authorization) the key is stored securely and never shown in the browser oauth2 (client credentials) — for providers that issue access tokens enter token url, client id, client secret, and optional scope / audience hyperportal obtains and refreshes the token automatically endpoint configuration base url — the provider’s search endpoint method — get / post usually get query parameter — the name of the parameter that carries the user’s text (e g text, input, q) result path — where the list of suggestions lives in the response (e g features, predictions, results) two step providers enable two step if your provider needs a second call to return full address details id path — path to the identifier inside each suggestion (e g place id) details url — the details endpoint use {id} as a placeholder, or set a details id parameter details method — get / post usually get details id parameter — the parameter name that carries the id (if not using {id} in the url) details result path — where the full address object lives in the details response (e g result) test request type a sample query and press run to confirm the connection works you’ll see the status and the raw response, so you can check the paths above for providers that require credentials, save the service first, then run step 2 enable address search on a property add a json property to your entity, and go to the view tab set the view type to search field then configure service — the search service (from part 1) this field should use allow manual entry — let users type a free form value that isn’t in the suggestions minimum character — how many characters before suggestions appear label path — the field shown as each suggestion’s text (e g properties formatted, description) response mapping automatically fill other properties when an address is selected add a row per target field property — the item property to fill (e g city, zip, country) value — the path to the value in the selected address (e g properties city) response mapping applies everywhere items are edited the item page, table inline editing, quick add, and bulk edit provider examples geoapify free worldwide provider need a registration to get an api key https //www geoapify com/ https //www geoapify com/ data gouv fr free french provider works without authentication