Online Presence Checks

Introduction

This tutorial will teach you how to check the status of locations on directories (Foursquare, Google etc) by using uberall API. This should be used for an Online Presence Check tool, not for regular status checks of your locations or your customers' locations.

Common Endpoints

Method	Endpoint	Description
GET	`/search/$id`	Searches for the given location in the given directory
POST	`/search`	Initiates a search with the given parameters. The result should be used to further search in specific directories

Example

{
 "name": "Uberall",
 "street": "Oranienburgerstr 66",
 "zip": 10117,
 "country": "DE"
}

Initiate search

Use /search to initiate the process. You will get the location id and the token you will need for next step. This allows us to connect the results for all directories in one search object.

curl -X POST -H 'privateKey:$privateKey' 'https://sandbox.uberall.com/api/search?name=uberall&street=oranienburgerstr%2066&zip=10117'

This is what the response should look like.

{
  "status": "SUCCESS",
  "response": {
    "searchData": {
      "id": 1347761,
      "token": "Izsz5HyY2MXPYr6i",
      "name": "Uberall",
      "street": "Oranienburger Straße",
      "streetNo": "66",
      "zip": "10117",
      "city": "Berlin",
      "country": "DE",
      "shortUrl": "https://sandbox.uberall.com/en/status/recheck/1347761-Izsz5HyY2MXPYr6i"
    },
    "alreadyManaged": true
  }
}

In this example, the id of the normalized location is 1347761 and the token is Izsz5HyY2MXPYr6i.

Check the status of the location on a specific directory

You will need the id and the token of the normalized location. You can then use /search/$id to check the status of the location on a directory. See the request and the response below for Foursquare.

curl -X GET -H 'privateKey:$privateKey' 'https://sandbox.uberall.com/api/search/1347761?token=Izsz5HyY2MXPYr6i&directory=FOURSQUARE'

{
  "status": "SUCCESS",
  "response": {
    "result": {
      "listingId": "515c4010fe701fcb8267a454",
      "listingUrl": "http://4sq.com/11mdR4E",
      "syncStatus": "NOT_IN_SYNC",
      "flowStatus": null,
      "claimStatus": "CLAIMABLE",
      "dateCreated": "2015-07-09T15:04:56.454+02:00",
      "directoryType": "FOURSQUARE",
      "country": "DE",
      "name": "uberall",
      "nameStatus": "MATCH",
      "street": "Oranienburger Str.",
      "streetStatus": "MATCH",
      "streetNo": "66",
      "streetNoStatus": "MATCH",
      "zip": "10117",
      "zipStatus": "MATCH",
      "city": "Berlin",
      "cityStatus": "MATCH",
      "phone": "+4930208479320",
      "phoneStatus": "PRESENT",
      "website": "http://www.uberall.com",
      "websiteStatus": "PRESENT",
      "descriptionShort": "Wir machen Unternehmen überall dort auffindbar, wo Menschen online suchen. Unternehmen erstellen ein zentrales Profil bei uns und wir verbreiten es automatisch - bei Google, Gelbe Seiten und Co.",
      "descriptionShortStatus": "PRESENT",
      "openingHours": [
        {
          "to1": "19:00",
          "from1": "09:00",
          "dayOfWeek": 1
        },
        {
          "to1": "19:00",
          "from1": "09:00",
          "dayOfWeek": 2
        },
        {
          "to1": "19:00",
          "from1": "09:00",
          "dayOfWeek": 3
        },
        {
          "to1": "19:00",
          "from1": "09:00",
          "dayOfWeek": 4
        },
        {
          "to1": "19:00",
          "from1": "09:00",
          "dayOfWeek": 5
        }
      ],
      "openingHoursStatus": "PRESENT",
      "categories": [
        {
          "id": 15874,
          "name": "Design Studio",
          "fullName": "Geschäft & Dienstleistungen > Design Studio",
          "selectable": true
        }
      ],
      "categoriesStatus": "PRESENT",
      "photos": true,
      "photosStatus": "MISSING",
      "specialOffer": null,
      "specialOfferStatus": "MISSING",
      "streetTypeStatus": "NOT_APPLICABLE",
      "addressExtraStatus": "NOT_APPLICABLE",
      "faxStatus": "NOT_APPLICABLE",
      "cellphoneStatus": "NOT_APPLICABLE",
      "emailStatus": "NOT_APPLICABLE",
      "descriptionLongStatus": "NOT_APPLICABLE",
      "openingHoursNotesStatus": "NOT_APPLICABLE",
      "keywordsStatus": "NOT_APPLICABLE",
      "legalIdentStatus": "NOT_APPLICABLE",
      "taxNumberStatus": "NOT_APPLICABLE",
      "provinceStatus": "NOT_APPLICABLE",
      "countryStatus": "NOT_APPLICABLE",
      "contentListsStatus": "NOT_APPLICABLE",
      "videosStatus": "NOT_APPLICABLE",
      "socialProfilesStatus": "NOT_APPLICABLE",
      "brandsStatus": "NOT_APPLICABLE",
      "languagesStatus": "NOT_APPLICABLE",
      "paymentOptionsStatus": "NOT_APPLICABLE",
      "servicesStatus": "NOT_APPLICABLE",
      "attributionStatus": "NOT_APPLICABLE"
    },
    "alreadyManaged": true
  }
}