Quick start

1. Yandex Maps API key

Without a key the map and server geocoder do not work. One key in yandexmapslocator_api_key:

Where	Why
Browser (api-maps.yandex.ru/2.1)	Map and markers
Server (geocode-maps.yandex.ru)	Address search, geolocation, mgr button, REST geocode (Pro)

1. Sign in to the Developer Dashboard with Yandex ID.
2. Enable JavaScript API and HTTP Geocoder.
3. Copy the key (activation up to ~15 minutes).
4. System → System Settings → yandexmapslocator → yandexmapslocator_api_key.

In the dashboard restrict the key by HTTP Referer (site domains) and by IP for server geocoding. Do not put the key in chunks or Git.

2. Container and locations

1. Create a container resource (e.g. "Stores").
2. Add published child resources: one location per resource.
3. Fill TVs (category YandexMapsLocator): address, coordinates, phone, etc.
4. Or enter an address and click "Get coordinates" on the resource form (Free plugin).

TV names and renaming: Locations and TVs.

3. Snippet on the page

fenom

{'!YandexMapsLocator' | snippet : [
    'parents' => 123,
    'radius' => 50,
    'sortby' => 'distance'
]}

modx

[[!YandexMapsLocator?
    &parents=`123`
    &radius=`50`
    &sortby=`distance`
]]

Requires pdoTools (Fenom chunks). Call must be uncached.

Default chunks: yandexmapslocator.outer, .search, .store, .empty, .error.

Parameters: YandexMapsLocator.

Other common calls:

fenom

{* Category *}
{'!YandexMapsLocator' | snippet : [
    'parents' => 123,
    'category' => 'аптека',
    'filters' => 'category'
]}

{* Open now — requires Pro *}
{'!YandexMapsLocator' | snippet : [
    'parents' => 123,
    'filters' => 'working_now'
]}

modx

[[!YandexMapsLocator?
    &parents=`123`
    &category=`аптека`
    &filters=`category`
]]

[[!YandexMapsLocator?
    &parents=`123`
    &filters=`working_now`
]]

4. Check

1. Open the page: search form, list, and map visible.
2. Enter an address → "Find".
3. "My location" → sort by distance, button switches to "All locations".
4. On mobile: "List" / "Map" tabs.

5. Pro (optional)

After installing Pro:

1. Set yandexmapslocator_timezone for the network (Omsk network: Asia/Omsk) and TV yandexmaps_timezone on locations if needed.
2. For REST: yandexmapslocator_api_token and api_cors_origins on production.
3. CSV and bulk geocode: Components → YandexMapsLocator Pro.

Pro ≥ 1.1.0-pl2, Free ≥ 1.0.0-pl7. See Free and Pro, What Pro adds.