Get Started with Woosmap

Woosmap is a Local Search Engine as a Service, which helps developers and marketers to add a local approach to the customer journey. Our contributions are focused on the knowledge of the geographic profile of your website visitors and linking them to your point of sale. We’re here to help you become an expert in the local aspect of your customers, ready to get started?

In this article, you’ll learn how to start embedding Woosmap features in your website, and we’ll provide some helpful resources to use as you work.

Before You Start

Before we go any further, here are a few helpful things to know.

  • Woosmap is a combination of REST and Javascript APIs, and a web-based embeddable store locator that works with all modern web browsers, which means you don’t need to download or install any software on your computer. To be sure Woosmap works properly in your browser, you should enable cookies and JavaScript.

  • It’s important to note that when you create a Woosmap account, you agree to comply with our Terms of Use.

  • We offer a number of online resources to provide help and insights about our tools and features. Check out our searchable Knowledge Base if you want to learn how something works, or if you run into any trouble.

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.

Sign Up Woosmap

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.

Woosmap Create an Organisation

The organization owner is able to invite other users. Being part of an organisation means that you can create a project and see detailed analytics usage.

Create A Project And API KEYs

Projects are containers for your locations and associated analytics usage. The next step after creating your organization is to add a project to it.

On the console home page, click on the CREATE A NEW PROJECT button. You’re prompted to input the name and domains corresponding to the allowed referrers where you’ll embed Woosmap.

Woosmap Home Console

Each project has, at least, one associated pair of keys. These keys are used to manage your locations data programmatically, use REST and Javascript APIs, and display the dealer/store locator widget.

There are two kinds of keys:

  • Public keys
  • Private keys

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. Private keys allow you to manage integrations on the server-side and perform creation of new and updates of existing locations.

The public key is automatically generated when you add a new project to your organization, while you need to create the private key manually.

Woosmap Create a Private Key

As we aggregate analytics usage per project, it is good form to create separate projects based on intended use, such as one for your staging environment and one for the production environment.

Prepare And Upload assets Data

If you have followed all of the previous steps carefully, you should now be ready to prepare your own assets data before uploading them using our REST Data API.

Without any doubt, this is the trickiest part before benefiting from Woosmap. You must be familiar with the basics of programming. If you think you may need some help with integrating the Woosmap Data API, connect with one of our experts to help achieve this step for you.

Many organizations use spreadsheets to store location data. As Woosmap API only accepts JSON as input, you’ll need to transform each row of your file to Woosmap elements. Here is the required data (see Data Structure for more details).

{
    "storeId": "unique identifier",
    "name": "Store Name",
    "location": {
        "lat": 43.600,
        "lng": 3.883
    }
}

If your data is not already geocoded, you’ll need to do so and append the latitude/longitude (lat / long) coordinates to your original file. Take a look at this article on our corporate blog: Bulk Geocode addresses using Google Maps and GeoPy.

Now, you are able to upload your store location data to Woosmap. You may use various python script hosted on our public GitHub. Check the “Batch Import” script to bulk import data from a CSV file. Also, this blog post may be a good introduction to upload data to Woosmap. And once again, don’t hesitate to reach out for help through our contact page, we could do this task for you!

Embed Your Store Locator Widget

Congratulations! You are now able to embed Woosmap in your website. Beforehand, review your locations in the Woosmap console:

  1. Navigate to your Project page.

  2. Click on the name of your newly created project.

  3. Go to the Widgets Tab to review your locations through the Store Locator Widget.

Review your Locations - Woosmap

Above the map, click on the block Integration code and copy/paste the Javascript snippet wherever you want to embed the Store Locator Widget, and enjoy Woosmap.

Embed the Woosmap Store Locator Widget

You now have a starting point from which to proceed with the Woosmap Recommendation.

Embed Your Recommendation

The final step is to embed the Woosmap Recommendation widget in your website. When a web user arrives on your site where you implemented this feature and their location is already known - they already interacted with Woosmap on your website or on another Woosmap ready website - you can automatically recommend the best location based on their profile. If the visitor is unknown to the Woosmap profile database - no cookie has yet been set - invite them to provide location data through a simple search field with geocoding or HTML5 Geolocation sharing thanks to browser capability.

We strongly recommend you to take a look at the Recommendation Overview and sample Use Cases to learn more about this feature.

Dashboard And Analytics

Woosmap includes some reporting capabilities that will help you understand more about your location data. To access the reports, simply go to the stats tab when viewing your project information. You can control the key metrics you want to focus on by clicking directly on the diagram.

Woosmap Dashboard and Analytics