Last updated

Uberall API

The uberall API offers developers access to robust Location Marketing at Scale capabilities. Uberall streamlines the process, ensuring your brand achieves prominence when nearby customers search. From initial discovery to completed transactions and continuous engagement, Uberalls API empowers developers to create tailored solutions seamlessly integrated into their own applications and technology stack, all with our dedicated developer support.

Build something great.

Getting Started

Register

Not registered as a sales partner yet? Get in touch with us!

Get your API keys

You can find your API keys under Org settings -> API Keys, when logging into the uberall app using an ADMIN account.

Start making requests!

Make requests to our API Reference with your API keys.

Tutorials

Getting started with the uberall API

Authentication and versioning

API Keys

The uberall API uses 2 API keys to identify your application. Make sure you always use one of the keys in the header to make your API calls, otherwise you may experience unexpected results:

  • privateKey – used for server-to-server communication. Not to be shared.
  • publicKey – used for API calls made from the client’s browser. Limited rights, only usable for the status check.

Example call

curl --location 'https://uberall.com/api/locations' \
--header 'privateKey: $private_key'

Your API keys can be found inside the platform on this page.

Versioning

The version parameter v is designed to give developers the freedom to adapt to uberall API changes on their own schedule. Send the version parameter v either as a URL parameter or as a header in YYYYMMdd format (e.g. 20161216) to tell us you are prepared for API changes up to this date.

Version changelog

Track the latest API changes here.

Sandbox Environment

Uberall API testing playground

Uberall API has a test mode (sandbox) that lets you experiment in a safe environment without actually syncing your data outside of the platform.

How to use the Sandbox Environment

Go to https://sandbox.uberall.com/en/app/uberall/login and log in with the same credentials that you normally do. Then, retrieve the privateKey from your settings. From then on, you can make calls to https://sandbox.uberall.com/api/.

Limited functionalities

Note: The sandbox environment is not connected to third party directories, so there are certain things that are not supported such as:

  • Submission and sync checking of location data on directories
  • Submission of posts, retrieval of customer feedback (reviews) and insights (analytics) from directories
  • Status check and 'Near Me' 360

Sandbox reset dates

Every two weeks we reset the sandbox environment. You can read more about the process and the scheduled reset dates.

TLS Support

Following table will explain which TLS versions are being accepted by our different environments. If you are doing requests with a minor version these calls won't be accepted.

EnvironmentMinimum Version
Production1.2
Sandbox1.2