Woosmap Platform API
The Woosmap API is a RESTful API built on HTTP. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Woosmap API is a RESTful API built on HTTP. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use Woosmap's API, or you can use one of our Javascript SDKs for supported APIs:
- Map JS - support All APIs
- Localities JS - for Localities API
- MultiSearch JS - for Localities API and Stores API
You can use Postman to test the API (if you use the PUBLIC_API_KEY authentication, don't forget to set the Referer Header corresponding to one of your restricted domain name).
Endpoints 17
Data Management
- PUTUpdate the Assets
/storesUsed to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused. - POSTCreate your Assets
/storesUsed to batch create Assets to a specific project identified with the private_key parameter. - DELETEDelete the Assets
/storesUsed to delete one or more assets. The storeId specified in query parameter is the id of the asset to delete. To delete several assets, use the comma as a… - GETGet Asset from ID
/stores/:storeIdUsed to retrieve an asset from his storeId - POSTReplace all assets
/stores/replaceTo replace all your Assets. This endpoint will delete all previous assets and import assets in request body. During the operation previous assets could always…
Zones
- GETList your Zones
/zonesList all zones for the current project, sorted by zone_id. - PUTUpdate the Zones
/zonesUsed to update zones in batch. zone_id must exists when using PUT method, if one zone does not exists, the batch will be refused. - POSTCreate your Zones
/zonesUsed to batch create Zones to a specific project identified with the private_key parameter. - DELETEDelete the Zones
/zonesUsed to delete one or more Zones. - GETGet Zone from ID
/zones/:zone_idUsed to retrieve a zone from his zone_id - DELETEDelete Zone from ID
/zones/:zone_idUsed to delete one Zone. The zone_id is the id of the zone to delete. To delete several zones, use the comma as a separator.
Geolocation API
- GETGeolocation from an IP address
/geolocation/positionThe /position returns JSON location of your users thanks to IP address of their devices. - GETAssets nearby a Geolocation
/geolocation/storesRetrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less. - GETTimezone
/geolocation/timezone?location=stringReturns timezone information based on the location, and optionally a timestamp for daylight saving time. > Note: rawOffset never contains the dst.
Store Search
- GETSearch for assets
/stores/searchUsed to retrieve assets from query. - GETAutocomplete for assets
/stores/autocompleteAutocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names. Without… - GETBounds for assets
/stores/search/boundsUsed to retrieve Bounds for assets.
API details
- Base URL
https://api.woosmap.com- Authentication
- An API key in the private_key query parameter
An API key in the key query parameter
An API key in the Referer header
An API key in the X-Api-Key header - Operations
- 17 operations on 11 pathsGET 9POST 3DELETE 3PUT 2
- Main resources
- Zones 6Data Management 5Geolocation API 3Store Search 3
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.46.4 - Links
- OpenAPI document · Terms of service
How to test the Woosmap Platform API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Woosmap Platform API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the private_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Update the Assets” (PUT /stores), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Woosmap Platform API?
The Woosmap API is a RESTful API built on HTTP. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and… It is listed under Maps & location and has 17 endpoints.
Who publishes the Woosmap Platform API?
It is listed from Woosmap's public API description (an OpenAPI document), not published by Woosmap on Swastik Codes. Anyone who controls woosmap.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Woosmap Platform API?
Requests go to https://api.woosmap.com. Endpoint paths are added to this base URL.
How do I authenticate with the Woosmap Platform API?
It accepts 4 methods: an API key in the private_key query parameter; an API key in the key query parameter; an API key in the Referer header; an API key in the X-Api-Key header.
How many endpoints does the Woosmap Platform API have?
17 operations on 11 paths (9 GET, 3 POST, 3 DELETE, 2 PUT). The largest groups are Zones, Data Management, Geolocation API, Store Search.
Is forking the Woosmap Platform API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.