Choosing Your Stores API Integration
Choose the right way to integrate Woosmap Stores API: REST API, Map JS API StoresService, Store Locator Widget, or Mobile SDKs.
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 data pipeline | REST API | Full, platform-agnostic control. |
| A location-aware web app | Map JS API | The recommended, unified map and search solution. |
| A store finder page | Store Locator Widget | The fastest setup with built-in UI. |
| A native mobile app | Mobile SDKs | Native iOS and Android integration. |
1. REST API
For any non-browser environment, the REST API is your starting point. It provides direct, platform-agnostic access to the Stores API engine.
- Use it for: Backend services, data processing, or mobile apps with custom HTTP clients.
- Key benefit: Full control with a secure, private API key.
2. Map JS API (Recommended for Web)
The Map JS API includes the StoresService class that unifies mapping and store search into a single library.
- Use it for: Interactive maps with store search, store locators built on Woosmap maps.
- Key benefit: A single library for all your location needs on the web.
See the Map JS StoresService Guide
3. Store Locator Widget
A ready-made, customizable UI component that provides a complete store locator experience, including search, filtering, and map display.
- Use it for: Getting a full store locator running quickly with minimal code.
- Key benefit: Fast deployment with extensive configuration options.
Go to the Store Locator Widget Quickstart
4. Mobile SDKs
Native SDKs for iOS and Android provide convenient tools for interacting with Stores API from mobile applications.
- iOS SDK: Stores Service Reference
-
Android SDK: Displaying Stores Guide API Reference -
Flutter: Store Overlay Guide Services Guide -
React Native: Store Overlay Guide Services Guide