Get Started
Get Started with Woosmap
Woosmap is a Location-based Search Platform, which helps developers adding a local approach to the customer journey. We’re here to help you become an expert in the local aspect of your customers, ready to get started?
Before You Start
Let’s begin with a few helpful things to know.
- Woosmap is a combination of REST and Javascript APIs, along with web embeddable widgets that works with all modern web browsers. It means you don’t need to download or install any software on your computer.
- When you create a Woosmap account, you agree to comply with our Terms of Use.
- If you need more help, please don’t hesitate to reach out to us via the chatbox or through the contact page.
- https://console-guide.woosmap.com/ will guide you to take control of the Woosmap Console.
Setup Your Account
When you sign up for a Woosmap account, you’ll enter your login/password and an email address, and we’ll send you an activation email.
When you receive the activation email, click the link to activate your account. The next time you log in to Woosmap Console, we’ll walk you through the rest of the setup steps described below.
Create An Organization
Once your account is activated, you’re invited to create an organization.
An organization allows a group of users to collaborate together effectively, all while keeping your organization’s information private.
The organization owner is able to invite other users. Being part of an organization means that you can manage projects and see detailed analytics usage.
Create A Project And API Keys
The next step after creating your organization is to add a project to it. A project is the basis for managing locations, credentials, and Products (APIs and SDKs).
First, specify which APIs to enable for your project among the following:
For better security, it is recommended to only enable APIs that you really need.
You’re then prompted to input the name and domains corresponding to the allowed referrers where you’ll embed Woosmap.
The project creation process automatically generates a public API Key. Public keys are used to implement Woosmap features on the client-side. They allow you to retrieve your location data and benefit from the read-only capabilities of Woosmap APIs.
To create new assets or updates existing ones, you’ll need to create a private API Key. Private keys allow you to manage integrations on the server-side and perform creation of new and updates of existing locations.
Next Steps
If you have followed all the previous steps carefully, you should now be ready to start using the desired Woosmap API.
Just checked that your credentials is OK by requesting the API with a curl command.
Below is an example for a Localities Autocomplete Request that should return a 200 response with predictions localities for London.
https://api.woosmap.com/localities/autocomplete/
?components=country%3Agb
&input=Lond
&no_deprecated_fields=true
&key=YOUR_PUBLIC_API_KEY
curl -L -X GET 'https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'
var requestOptions = {
method: 'GET',
redirect: 'follow'
};
fetch("https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
var axios = require('axios');
var config = {
method: 'get',
url: 'https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY',
headers: {
'Referer': 'http://localhost'
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
import requests
url = "https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY"
payload={}
headers = {
'Referer': 'http://localhost'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY")
.method("GET", body)
.addHeader("Referer", "http://localhost")
.build();
Response response = client.newCall(request).execute();
require "uri"
require "net/http"
url = URI("https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Referer"] = "http://localhost"
response = https.request(request)
puts response.read_body
