Set your default language: PHP | Curl

POST checkins

An alias / shortened endpoint for creating a checkin for a given place.

Details

URL https://api.heello.com/checkins.format
Requires Authentication Yes
Rate Limited Yes
Response Formats json

Parameters

Parameter Required Notes
access_token Access token of authenticated user creating the Ping.
ping[place_id] Place ID to attach to the checkin. Providing a place_id will override any lat / long values sent.

Note: Adding a place to a ping simply indicates where a ping took place. It does not indicate intent to create a 'check-in'. Check-ins are handled with a separate input.
ping[text] Text for the new checkin.
ping[media] Video or image data to attach to the checkin. Can be base64 encoded data, but should be attached via normal methods for uploading a file if possible to ensure greatest compatibility.
ping[post_fb] Indicate if this checkin should also be shared via Facebook. This requires that the user has previously authenticated with Facebook via the Heello site.
ping[post_twitter] Indicate if this checkin should also be shared via Twitter. This requires that the user has previously authenticated with Twitter via the Heello site.

Errors

There are no unique error states for this endpoint, please see our page detailing general errors you may encounter.

Example Usage

POST https://api.heello.com/places/checkin.json
curl \
-d "ping[place_id]=322-8a159504-35c1-490e-a9db-cce686a72c8c" \
-d "ping[text]=Greatest place on Earth!" \
-d "access_token=ACCESS_TOKEN" \
-X POST "https://api.heello.com/checkins.json"
// Note: PHP Examples use the Heello PHP Client library
// https://github.com/Heello/heello-php
require_once dirname(dirname(dirname(__FILE__))) . '/Heello.php';

// You can get an Application Key and Secret by visiting:
// http://developer.heello.com/apps
$api_application_key = "APPLICATION_KEY";
$api_application_secret = "APPLICATION_SECRET";

// You can get an access token and refresh token by implementing the auth
// flow described at (or use the demo provided):
// http://developer.heello.com/guides/authentication
$access_token = "ACCESS_TOKEN";

$api = new Heello\Client($api_application_key, $api_application_secret);
Heello\Client::config()->set_access_token($access_token);

try{
  $response = $api->checkins->create(array(
    "ping" => array(
      "text" => "Getting some books",
      "place_id" => "322-d0f33594-b696-423c-8c91-dd5e215ab3a9"
    )
  ));

  print_r($response);
} catch (Exception $e){
  print $e->getMessage();
}
On a successul request, a '201 Created' response is sent
with a Ping object for the checkin created.

See endpoint documentation for pings/show for details.

Live Demo

Please login and create an application to perform live API testing.