• Register

Quick Start Guide

To get started, you need to register for a user account and become part of the Soleo developer community. Don't worry, it's easy, you don't have to talk to a sales person, and it's completely free to sign up.

A user account and unique key are necessary whether you plan on using the Soleo Local Search API, widget, or a white labeled search solution.

On the registration page, begin by filling in the following fields:

  • Username: The username that you will use to sign in.
  • Display Name: The name that will display when you participate in the forums, blog, or doc comments.
  • E-mail: The e-mail address that we will use to confirm your user account. We will also send account-specific e-mail notifications to this address.

Continue filling out the remainder of the form:

  • New Password: Be sure to pick a strong password It must be at least eight characters and contain at least one number and one letter.
  • First Name: Your first name.
  • Last Name: Your last name. 
  • Company: The company that you represent.
  • Company URL: The web site address for your company. Note that the URL must be prefixed with "http://".

Click the checkbox to accept the Soleo Developer Terms of Service and Privacy Policy. Finally, click the "Register" button.

In a few minutes, you should receive an e-mail from Soleo Developer.

The e-mail contains a link to confirm the e-mail address that you entered in the user registration form. Click the link to confirm your e-mail address and apply for access to the API.

Once you have clicked the e-mail confirmation link you will be presented with a "Registration Successful" screen. On this screen, you must click on the link associated with item 1 "Apply for access to the API". This will allow you to define a test application, generate a trial key, and complete the onboarding process.

When you click the API link in item 1, you will be presented with the Soleo Developer Center Application Registration form. On this form complete the following fields:

  • Name of your application: Enter a name for your Soleo Local Search application. You can name it whatever you like. You can always edit the application settings later through the My Account page on the developer site. 
  • Application Type: Select a type of application that best fits your planned implementation from the drop down menu.
  • Check the box next to Issue a new key for Soleo Local Search API Package. This will give you access to the Trial API Plan with initial limits of 3 calls per second and 10,000 calls per day.

Other fields on this form are optional at this time. You can always edit these fields later on through the My Account page. When you have filled in the required fields, click the Register Application button. This will log you in to your developer account, create your initial application, and create a corresponding key. You will also be emailed a copy of your key.

Your registration and initial setup are now complete!   

As you become familiar with the technology, you can work with Soleo to configure additional options that will optimize search functionality and performance for your solution. Finally, when you are ready to go live in a production environment, Soleo will help validate your application to ensure reporting events are correctly captured and revenue generation can begin!

To try out the API using your key go to IO DOCS. To try out the widget go to Soleo's widget page.

Get detailed information on how the API works by reviewing the API Reference Guide.