# 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!](mailto:support@uberall.com)

### Get your API keys

You can find your API keys under Org settings -> [API Keys](https://uberall.com/en/app/uberall/apiKeys), when logging into the uberall app using an ADMIN account.

### Start making requests!

Make requests to our [API Reference](/apis/swagger) with your API keys.

## Tutorials

Getting started with the uberall API

Online Presence Checks
Build a custom online Presence Check tool for your prospects or your customers

Sync
Update all your locations' data across your website, landing pages, and online directories

Reputation Management
Get access to user-generated content about your locations or your customers locations

Resell
Manage your clients, their accounts, and their pricing plans

## Authentication and versioning

### API Keys – Headers & Backward Compatibility

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:

- `X-API-KEY` – used for server-to-server communication. Not to be shared.
- `X-PUBLIC-API-KEY` – used for API calls made from the client’s browser. Limited rights, only usable for the status check.


We recently introduced **new standardized headers** to replace legacy ones, while ensuring **backward compatibility** for existing clients.

#### Authentication Headers

| Purpose | New Header | Legacy Header | Usage Context |
|  --- | --- | --- | --- |
| Bearer Access Token | `Authorization: Bearer ...` | `accessToken` | Standard authenticated API access |
| Private Server Key | `X-API-KEY: ...` | `privateKey` | Server-to-server secure access |
| Public Client Key | `X-PUBLIC-API-KEY: ...` | `publicKey` | Public status check (limited) |


> All legacy headers remain supported to ensure compatibility with older clients. However, it is **strongly recommended** to migrate to the new headers for consistency and future-proofing.


##### Example calls

**New (Preferred):**


```bash
curl --location https://uberall.com/api/locations \
--header 'Authorization: Bearer $ACCESS_TOKEN'
```


```bash
curl --location 'https://uberall.com/api/locations' \
--header 'X-API-KEY: $PRIVATE_KEY'
```


```bash
curl --location 'https://uberall.com/api/locations' \
--header 'X-PUBLIC-API-KEY: $PUBLIC_KEY'
```

**Old (legacy)**


```bash
curl --location 'https://uberall.com/api/locations' \
--header 'accessToken: $ACCESS_TOKEN'
```


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


```bash
curl --location 'https://uberall.com/api/locations' \
--header 'publicKey: $PUBLIC_KEY'
```

Your API keys can be found inside the platform on this [page](https://uberall.com/en/app/uberall/apiKeys).

### Access Token Lifecycle and Authentication

Our authentication system is designed for both security and convenience. Here's how access tokens work:

- **Seamless Use:** As long as you use the system regularly, you will not need to manually log in. The access token is automatically refreshed every 30 minutes during active use.
- **Automatic Token Refresh:** If you continue to interact with the platform (requests or API calls) without a break longer than 7 days, your token will keep refreshing automatically and your session will remain active.
- **Long Inactivity:** If your account is inactive (no use of the access token) for more than 7 consecutive days, you will be required to authenticate again with a manual login.
- **Summary Table:**


| Scenario | Token Refresh | Manual Login Required? |
|  --- | --- | --- |
| Regular use (≤7 days gap) | Every 30min | No |
| No use for >7 days | None | Yes |


> **Note:** This policy helps protect your account while minimizing interruptions. If you're building integrations, ensure your apps handle token renewal logic and prompt users to re-authenticate after extended inactivity.


### 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](https://uberall.helpjuice.com/api/551328).

## 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](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/](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](https://uberall.helpjuice.com/partner-integration/682294) 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.

| Environment | Minimum Version |
|  --- | --- |
| Production | 1.2 |
| Sandbox | 1.2 |