Choosing Your Localities Integration
Select the best way to integrate Woosmap Localities. This guide covers the REST API, the recommended Map JS API, and other client-side libraries.
This guide helps you choose the right integration path for your project. Find your use case in the summary table below or jump to a specific section for details.
Choose Your Integration Path
| If you’re building… | Use This | For… |
|---|---|---|
| A backend or mobile app | REST API | Full, platform-agnostic control. |
| A location-aware web app | Map JS API | The recommended, unified map and search solution. |
| A simple web search bar | JS Widget | The fastest setup for non-map use cases. |
| A custom web UI | JS SDK | Complete UI control for non-map use cases. |
| A store locator | Store Locator Widget | Customizing the built-in search functionality. |
1. REST API
For any non-browser environment, the REST API is your starting point. It provides direct, platform-agnostic access to the core Localities engine.
- Use it for: Backend services, mobile apps, or data processing.
- Key benefit: Full control with a secure, private API key.
2. Map JS API (Recommended for Web)
This is the primary, forward-looking solution for building location-aware web applications. The Map JS API includes a
powerful LocalitiesService that unifies both mapping and search into a single, seamless library.
- Use it for: Interactive maps with address search, geocoding results, and building rich geospatial experiences.
- Key benefit: A single, powerful library for all your location needs on the web.
3. Other Web Integrations
For web use cases that do not involve a map, these standalone libraries are excellent choices.
-
JavaScript Widget: The fastest way to get a pre-built address search bar. It’s a plug-and-play UI component that works in minutes. Go to the Widget Quickstart
-
JavaScript SDK: For when you need to build a completely custom user interface. The SDK gives you the raw data to control the entire search experience. See the JavaScript SDK Guide
4. Customizing the Store Locator
If you’re using the Store Locator Widget, you can customize its built-in Localities search to switch from geocoding to interactive autocomplete and filter the results.
See the Store Locator Integration Guide