Check-in Stream (BETA)

The Nearby New Check-in API is organized around REST. JSON will be returned in all responses from the API, including errors.

Endpoint


http://test-api.sidebox.com/checkin/stream


Authentication

All calls made to the Nearby Now Review Checkin Location API require authentication.

You authenticate to the Nearby Now API by providing your Agency API key, and one of your client’s Account API keys in the request. Your agency API keys, and customer account API keys carry many privileges, so be sure to keep them secret.

Authentication to the API occurs via HTTP Basic Auth. Provide your agency API key as the basic auth username, and your client’s Account API key as the basic auth password.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Parameters

• MinDate: (optional) mm/dd/yyyy defaults to 30-days ago
• MaxDate: (optional) mm/dd/yyyy defaults to today
• PhotosOnly: (optional) defaults to false
• Count: (optional) defaults to 15

Errors

The Nearby Now API uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, authentication information was missing, etc.), and codes in the 5xx range indicate an error with Nearby Now’s servers.

All requests, success or failure, will return a JSON response with a List Object a success flag, and an array of check-ins. A failed request will contain an error message string describing the problem.

Examples

Here’s an example cURL request that shows how simple it is to call the Nearby Now API, as well as an example success and error response:

curl http://test-api.sidebox.com/checkin/stream \
   -u 'agency_api_token:account_api_token' \
   -F count=10 \
   -F photosOnly=true

Example Response:

{
    "obj": "list",
    "url": "/checkin/stream",
    "success": true,
    "data": [
        {
            "id": "some-unique-id",
            "obj": "checkin",
            "created": 1429621769,
            "user": "Billy C.",
            "reference": "New roof installation going on today. Installing Owens Corning Oakridge 30 year laminate and all new guttering. ",
            "location": {
                "address_street": "145 N 4th St",
                "address_city": "Clearwater",
                "address_state": "KS",
                "address_postal_code": "67026",
                "address_country": "US",
                "latitude": 37.50812,
                "longitude": -97.4974405
            },
            "media": {
                "extension": ".jpg",
                "type": "Photo Album Image",
                "endpoint": "path-to-image.jpg"
            }
        },
        ...
    ],
    "count": 3
}