mixi Developer Center (ミクシィ デベロッパーセンター)

mixi Connect

mixi Connect » mixi Graph API » 技術仕様 » Check-in API

Check-in API

mixiチェックインは、携帯電話のGPS機能を利用して、今いる場所やお店（スポット）を簡単に友人・知人に共有できるコミュニケーション機能です。

あらかじめ登録されている「渋谷駅」や「忠犬ハチ公」などといったスポットにチェックインし、友人に共有することができます。友人とのみ共有できる新たなスポット（マイスポット）を作成することも可能です。また、コメントやイイネ！といったフィードバック機能により、友人がチェックインした場所やお店などの情報を媒介としたコミュニケーションを円滑に楽しんでいただけるようになります。

Check-in APIを利用することで、特定のユーザや友人のチェックイン一覧、スポットへのチェックイン、そしてイイネ！やコメントをAPIを通じて行うことが可能となります。

ここでは、Check-in APIについて、その使用方法を説明します。

※周辺スポットの検索はマイスポットのみ提供しております。

共通仕様

事前に必要なもの

Check-in APIを利用するためには、以下の情報をすでに入手している必要があります。

  • “r_checkin” または “w_checkin” スコープおよびその両方について認可されたアクセストークン

上記以外のスコープで認可されたアクセストークンを使用して、Check-in APIにアクセスすることはできません。アクセストークンの入手方法については、認証認可手順のページをご覧ください。

Check-in APIで提供される機能と必要なスコープ

Check-in APIでは様々な機能が提供されますが、それらは大きく「参照系」「投稿系」の2つに分類されます。この分類は、そのままCheck-in APIを利用するためのスコープに対応します。以下に、スコープと各機能の対応を示します。

スコープ 機能
r_checkin あるスポットの取得
周辺マイスポットの検索
マイスポット一覧の取得
チェックイン・フィードの取得
あるチェックインの取得
あるチェックインへのコメント一覧の取得
あるチェックインへのイイネ一覧の取得
w_checkin マイスポットの作成
マイスポットの削除
あるスポットにチェックイン
あるチェックインの削除
チェックインへのコメント投稿
チェックインへのコメント削除
チェックインへのイイネ投稿
チェックインへのイイネ削除

位置情報について

位置情報の表記は十進数表記です。また、測地系はWGS84に基づいています。

fieldsパラメータに指定可能な値

参照系のAPIはfieldsパラメータをサポートしています。fieldsパラメータには取得したいフィールドをカンマ(“,”)区切りで指定します。また、フィールドがオブジェクトの場合はドット表記による指定が可能です。たとえば、”user.id”を指定すると”user”フィールドは”id”フィールドを含みます。

  • fields パラメータに”@all”が指定された場合、すべてのフィールドが含まれます。
  • fields パラメータが省略された場合は、各オブジェクトで「必須」「任意」になっているフィールドが含まれます。
  • fields パラメータが指定された場合、各オブジェクトで「必須」になっているフィールドと指定されたフィールドが含まれます。

(例) スポット取得で fields=name,address.geohash を指定した場合

{
  "id": "S100",
  "name": {
    "formatted": "コーヒー専門店 銀座３丁目店"
  },
  "address": {
    "latitude": "37.416343",
    "longitude": "-122.153013",
    "geohash": "abc7h36zwv4g"
  }
}
  • idフィールドは「必須」なので含まれる
  • nameフィールドは、fields パラメータで指定されているので含まれる
  • address.geohashフィールドは、fieldsパラメータで “address.geohash” が指定されているので含まれる
  • address.latitudeとaddress.longitudeフィールドは「必須」なので含まれる

絵文字の扱いについて

チェックインとコメントの投稿では絵文字の投稿もサポートしています。それらの API では、Graph API共通の emojiCarrier, emojiCharset が指定可能です。詳しくは「API共通仕様」の「絵文字の扱いについて」を参照してください。

sinceIdとresultsDirectionによるページングの指定方法

スポット検索とチェックイン・フィードの取得APIでは、以下のパラメータでページングを指定します。

パラメータ名 説明
sinceId 取得結果の基点となる ID を指定します
resultsDirection “recent”の場合、もっとも最新の結果からsinceIdで指定された位置まで取得します (※1)
“next”の場合はsinceIdで指定された位置よりソート順で後方の結果を取得します。(※1)
count 取得最大件数

(※1) sinceIdで指定された位置の要素は、結果に含まれません。また、最大でもcount件までの要素が返されます。

  • totalResults,startIndexは結果に含まれません。
  • resultsDirectionのデフォルト値はチェックインフィードで”recent”, スポット検索で”next”になります。

共通エラー仕様

正常に処理が行われなかった場合は、以下のエラーが返却されます。レスポンス・ボディがJSON形式のオブジェクトになっており、errorフィールドの値でどのエラーかを判別可能です。

状況 ステータスコード error フィールドの値 補足
リクエスト内容のフォーマットが仕様に適合していない 400 (Bad Request) parameter_invalid “parameters_invalid”フィールドに、エラーの原因となったパラメーターの名前が格納されます
必須パラメーターが不足している 400 (Bad Request) parameter_absent “parameters_absent”フィールドに、不足しているパラメーターの名前が格納されます
利用可能な容量や件数をオーバーしている 403 (Forbidden) parameter_over_capacity マイスポット作成時に作成数上限に達している場合などに返却されます
アクセスできないコンテンツ 403 (Forbidden) permission_denied –
対象コンテンツまたは対象ユーザが存在しない 404 (Not Found) not_found –

たとえば、以下のようなレスポンス・ボディが返却されます。

{
    "error": "parameter_invalid",
    "parameters_invalid": "fields,center",
    "error_description": "Invalid parameters found"
}

オブジェクト

API のリクエストやレスポンスに含まれる各オブジェクトの仕様について記述します。

スポット／マイスポット (Spot)
フィールド名 タイプ 内容 必須/任意 例
id String スポットとマイスポット共通のID 必須 “S100″, “M100″
name Name スポットの名前 任意 (別項)
description String 自由記入の説明文 任意 “コーヒー専門店です”
owner User スポット管理者 任意 (別項)
categories Array<Category> カテゴリ 任意 (別項)
address Address 住所 任意 (別項) 
{
  "id": "S100",
  "name": {
    "formatted": "コーヒー専門店 銀座３丁目店"
  },
  "address": {
    "formatted": "〒104-0061 東京都中央区銀座３丁目７-１"
    "latitude": "37.416343",
    "longitude": "-122.153013",
    "geohash" : "abc7h36zwv4g",
    "distance": "3.112593239511196"
  },
  "categories": [ { "formatted": "飲食業" } ],
  "description": "ここに店舗の説明文が入ります"
}
チェックイン履歴 (Checkin)
フィールド名 タイプ 内容 必須/任意 例
id String チェックイン履歴の ID 必須 “1FZ3P4ACUWBBC-2010061010321″
user User チェックインしたユーザ 任意 (別項)
message String メッセージ 任意 “銀座３丁目店の2階”
spot Spot 対象スポット 任意 (別項)
location Location 位置 任意 (別項)
numComments String コメント数 任意 “3″
numFavorites String イイネ数 任意 “3″
comments Array<Comment> 最新コメント (※1) 指定 (別項)
favorites Array<User> 直近でイイネしたユーザ (※1) 指定 (別項)
favorited Boolean 認可ユーザがイイネ済みである場合は{{true}}それ以外の場合は{{false}} 任意 true
photo Array<Photo> 添付写真 (※3) 指定 (別項)
created String 作成日時 任意 “2010-11-02T10:42:57+09:00″ (W3C-DTF) (※2)

(※1) 各チェックイン履歴の最新コメント／イイネで取得できるのは最新数件程度です。またサービス提供上の制約から API によって制限が決められている場合があります。
(※2) 日時の表記法であるW3C-DTFについてはW3Cのノートを参照してください。
(※3) fields に “photo” が指定されていた場合は、チェックイン本文に含まれる写真へのリンクを photo プロパティとして、本文から切り出して取得できます。

{
  "id": "1FZ3P4ACUWBBC-2010061010321",
  "user": {
    "id" : "1FZ3P4ACUWBB",
    "displayName" : "Becky",
    "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
    "profileUrl" : "http://mixi.jp/show_friend.pl?uid=1FZ3P4ACUWBB"
  },
  "message": "二階にはコーヒーバーカウンターやアート展示スペースがあります。",
  "spot": {
    "id": "S100",
    "name": {
      "formatted": "コーヒー専門店 銀座３丁目店"
    },
    "address": {
      "formatted": "〒104-0061 東京都中央区銀座３丁目７-１"
    },
    "location": {
      "latitude": "37.416343",
      "longitude": "-122.153013"
      "geohash" : "abc7h36zwv4g",
    }
  },
  "location": {
    "latitude": "37.416343",
    "longitude": "-122.153013"
  },
  "numComments": "3",
  "numFavorites": "5",
  "comments": [ ... ]
  "favorites": [ ... ],
  "favorited": false,
  "created" : "2010-11-02T10:42:57+09:00",
  "photo" : [
    {
      "albumId": "99465",
      "created": "2010-11-01T12:04:49+09:00",
      "exifCreated": "2010-11-01T11:34:35+09:00",
      "id": "117676",
      "largeImageUrl": "http://ic.photo.mixi.jp/v/fffd76a06cf4275c267257b96eb1c2c3c06bf8e25b/4cd21765/picture/u7dshdjk3mbc4x_117676_65xga.jpg",
      "mimeType": "image/jpeg",
      "numComments": "0",
      "numFavorites": "0",
      "thumbnailUrl": "http://ic.photo.mixi.jp/v/8684fa2911a044f9de932f6ee7f00f5d46ade867c8/4cd21765/picture/u7dshdjk3mbc4x_117676_65small.jpg",
      "title": "ふぁー",
      "type": "IMAGE",
      "url": "http://ic.photo.mixi.jp/v/8e0e2ab248dc82fe8bf016d7bb361f6117ab0cec5f/4cd21765/picture/u7dshdjk3mbc4x_117676_65large.jpg",
      "viewPageUrl": "http://mixi.jp/redirect_with_owner_id.pl?b=http%3A%2F%2Fphoto.mixi.jp%3A8150%2Fview_photo.pl%3Fphoto_id%3D117676&k=owner_id&v=7dshdjk3mbc4x"
    }
  ]
}
コメント・オブジェクト (Comment)
フィールド名 タイプ 内容 必須/任意 例
id String コメントの ID 必須 “sa1pzkdg9emdd-500000004743798-sa1pzkdg9emdd-20101208110507″
user User コメントしたユーザ 任意 (別項)
text String メッセージ 任意 “コメント本文”
created String 作成日時 任意 “2010-11-02T10:42:57+09:00″ (W3C-DTF) (※2)

(※2) 日時の表記法であるW3C-DTFについてはW3Cのノートを参照してください。

名前オブジェクト (Name)
フィールド名 タイプ 内容 必須/任意 例
formatted String 名前 必須 “コーヒー専門店 銀座３丁目店”

カテゴリ・オブジェクト (Category)

カテゴリ・オブジェクトは名前オブジェクトと同じフィールドを持ちます。

位置オブジェクト (Location)

フィールド名 タイプ 内容 必須/任意 例
latitude String 緯度。DEG (10進) 表記 必須 “37.416343″
longitude String 経度。DEG (10進) 表記 必須 “-122.153013″
geohash String Geohash 任意 “abc7h36zwv4g”
distance String 距離 (メートル) (※1) 任意 “3.112593239511196″

(※1) スポット検索などで、基準となる座標が与えられている場合のみ取得可能です。

住所オブジェクト (Address)

住所オブジェクトは位置オブジェクトのフィールドに加えて、以下のフィールドを持ちます。

フィールド名 タイプ 内容 必須/任意 例
formatted String 住所 (すべて) 任意 “〒104-0061 東京都中央区銀座３丁目７-１”
ユーザ・オブジェクト (User)
フィールド名 タイプ 内容 必須/任意 例
id String User-ID 必須 “1FZ3P4ACUWBBC”
displayName String ニックネーム 必須 “mixi公式”
thumbnailUrl String サムネイル画像 任意 “http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg”
profileUrl String プロフィールページのURL 任意 “http://mixi.jp/show_friend.pl?uid=1FZ3P4ACUWBB”
公開範囲オブジェクト (Privacy)
フィールド名 タイプ 内容 必須/任意 例
visibility String 公開範囲を表す文字列 必須 (別項)
group String visibilityが”group”の場合、公開先のグループIDを指定します (※1) 任意 “3″

(※1)グループIDについては、Groups APIにて取得したIDを指定する事となります。

visibility に指定可能な公開範囲は以下のとおりです。

指定値 意味
friends 友人まで公開
friends_of_friends 友人の友人まで公開
top_friends 仲良しに公開
group 特定のグループにのみ公開
self 非公開

(例1) 友人まで公開

{
    "visibility": "friends"
}

(例2) 特定のグループにのみ公開

{
    "visibility": "group",
    "group": "3"
}
写真オブジェクト (Photo)
フィールド名 タイプ 内容 必須/任意 例
id String このフォトを特定するためのID 必須 “117676”
albumId String アルバムのID (かんたん公開アルバムの場合は “@default”) 任意 “@default”
created String このフォトがアップロードされた日時 任意 “2010-11-02T10:42:57+09:00” (W3C-DTF) (※1)
mimeType String このフォトのMIME type 任意 “image/jpeg”
type String “IMAGE” 固定 任意 “IMAGE”
url String このフォトの大きめの画像のURL 任意 -
thumbnailUrl String このフォトのサムネイル画像のURL 任意 -
largeImageUrl String このフォトのXGAサイズの画像のURL 任意 -
viewPageUrl String このフォトのページのURL 任意 -
numComments String このフォトにつけられたコメントの件数 任意 “3”
numFavorites String このフォトにつけられたイイネ！の件数 任意 “3”
exifCreated String このフォトの撮影日 任意 “2010-11-02T10:42:57+09:00” (W3C-DTF) (※1)

(※1) 日時の表記法であるW3C-DTFについては[W3Cのノート|http://www.w3.org/TR/NOTE-datetime]を参照してください。

機能一覧 (スポット関連)

Check-in APIにより提供されるスポット関連の機能には、以下のものがあります。

  • あるスポットの取得
  • 周辺マイスポットの検索
  • マイスポット一覧の取得
  • マイスポットの作成
  • マイスポットの削除

あるスポットの取得

リクエスト仕様

あるスポットを取得するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/spots/[Spot-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
Spot-ID あるスポットのID

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –

レスポンス仕様

取得結果は以下のようになります。個々のエントリに含まれる情報はスポットオブジェクトになります。

<例>

{
    "id": "S100",
    "name": {
        "formatted": "コーヒー専門店 銀座３丁目店"
    },
    "address": {
        "formatted": "〒104-0061 東京都中央区銀座３丁目７-１"
    },
    "location": {
        "latitude": "37.416343",
        "longitude": "-122.153013"
    },
    "description": "ここに店舗の説明文が入ります"
}

※マイスポットは友人のマイスポットのみ取得可能です。

周辺マイスポットの検索

リクエスト仕様

周辺マイスポットを検索するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/search/spots

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –
center 検索対象となる範囲の中心地点を「緯度,経度」の順にカンマ区切りで指定します (※1) 必須 –
q キーワード検索の検索文字列 (※2) 任意 –
sinceId 取得結果の基点となる Spot-ID を指定します。(※3) 任意 –
resultsDirection sinceId を基点として、結果を取得する範囲を指定します。(※3) 任意 “next”
count 結果として取得したい最大件数を指定します 任意 20

(※1) 緯度経度に指定できる値の表記は DMS (度分秒), DEG (10進) の両方が指定可能です。
(※2) UTF-8でエンコーディングされた文字列をURLエンコードしたものを指定してください。
(※3) 詳しくは別項の「sinceIdとresultsDirectionによるページングの指定方法」を参照してください。

レスポンス仕様

取得結果は以下のようになります。個々のエントリに含まれる情報はスポットオブジェクトになります。
リクエスト時に指定された座標 (center) からの距離の昇順でソートされます。

{
    "startIndex": 0,
    "itemsPerPage": 10,
    "totalResults": 50,
    "entry": [
        {
            "id": "S100",
            "name": {
                "formatted": "コーヒー専門店 銀座３丁目店"
            },
            "address": {
                "formatted": "〒104-0061 東京都中央区銀座３丁目７-１"
            },
            "location": {
                "latitude": "37.416343",
                "longitude": "-122.153013"
            },
            "description": "ここに店舗の説明文が入ります"
        },
        ...
    ]
}

マイスポット一覧の取得

リクエスト仕様

マイスポット一覧を取得するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/spots/[User-ID]/@self

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –
startIndex 開始インデックス 任意 0
count 取得件数 任意 20

レスポンス仕様

取得結果は以下のようになります。個々のエントリに含まれる情報はスポットオブジェクトになります。
更新時間の降順でソートされます。

{
   "entry" : [
      {
         "owner" : {
            "thumbnailUrl" : "http://profile.img.mixi.jp/user/cdt9kxyucqnnd_3557510163.jpg",
            "id" : "cdt9kxyucqnnd",
            "displayName" : "テスト名前",
            "profileUrl" : "http://mixi.jp/show_friend.pl?uid=cdt9kxyucqnnd"
         },
         "name" : {
            "formatted" : "普通のスポット名"
         },
         "address" : {
            "longitude" : "+139.7660838889",
            "latitude" : "+35.6813819444",
            "geohash" : "xn76urwe1g9w"
         },
         "id" : "M296",
         "description" : "普通のスポットです[i:3]"
      }
   ],
   "startIndex" : 0,
   "itemsPerPage" : 20,
   "totalResults" : 1
}

※マイスポットは友人のマイスポットのみ取得可能です。

マイスポットの作成

リクエスト仕様

マイスポットを作成するためのURIは、以下となります。

POST https://api.mixi-platform.com/2/spots/[User-ID]/@self

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”

Content-Typeリクエスト・ヘッダに”application/json”を指定し、リクエスト・ボディにて以下の内容をJSON形式で送信します。
文字エンコーディングはUTF-8またはContent-Typeリクエスト・ヘッダのcharsetで指定します。ただし、emojiCarrier, emojiCharsetが指定されている場合は、そちらが優先されます。

フィールド名 タイプ 内容 必須/任意 デフォルト値
name String マイスポットの名前 必須 –
location Location 位置 必須 –
description String マイスポットの説明 任意 “”

<例>

{
    "name": "わたしのスポット",
    "location" : {
        "latitude" : "+35.6813819444",
        "longitude" : "+139.7660838889",
    },
    "description" : "マイスポットです"
}

レスポンス仕様

マイスポットの作成に成功した場合は、HTTPステータスコード201が返却されます。
レスポンス・ボディは以下の内容を含むJSONになります。

フィールド名 タイプ 内容 必須/任意 デフォルト値 例
id String マイスポットのID 必須 – “M296″

<例>

{
    "id": "M296"
}

マイスポットの削除

リクエスト仕様

マイスポットを削除するためのURIは、以下となります。

DELETE https://api.mixi-platform.com/2/spots/[User-ID]/@self/[Spot-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”
Spot-ID 対象マイスポットのID

レスポンス仕様

削除に成功した場合は、HTTPステータスコード200が返却されます。

HTTP/1.1 200 OK

機能一覧 (チェックイン関連)

チェックイン・フィードの取得

リクエスト仕様

チェックイン・フィードを取得するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/checkins/[User-ID]/[Group-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID
Group-ID フィード一覧を取得したいユーザの集合を特定するためのID (グループIDまたは “@self”, “@friends”, “@topFriends”) (※1)

(※1) User-ID がアクセストークンを認可したユーザのID以外の場合、Group-IDに指定できる値は”@self”のみです。

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –
spotId この ID が指すスポットのチェックイン・フィードを取得します 任意 –
center 取得対象となる範囲の中心地点を「緯度,経度」の順にカンマ区切りで指定します 任意 (※2) –
sinceId 取得結果の基点となるチェックインのIDを指定します。(※3) 任意 –
resultsDirection sinceIdを基点として、結果を取得する範囲を指定します。(※3) 任意 “recent”
count 結果として取得したい最大件数を指定します (※1) 任意 20

(※1) 実際の件数は指定した値よりも少ない可能性があります。
(※2) Spot-ID が指定されている場合は、そちらが優先されます。
(※3) 詳しくは別項の「sinceIdとresultsDirectionによるページングの指定方法」を参照してください。

レスポンス仕様

取得結果は以下のようになります。個々のエントリに含まれる情報はチェックイン履歴オブジェクトになります。
作成日時の降順でソートされます。

{
    "itemsPerPage": 20,
    "entry": [
        {
          "id": "1FZ3P4ACUWBBC-2010061010321",
          "user": {
            "id" : "1FZ3P4ACUWBB",
            "displayName" : "Becky",
            "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
            "profileUrl" : "http://mixi.jp/show_friend.pl?uid=1FZ3P4ACUWBB"
          },
          "message": "銀座３丁目店の2階にはコーヒーバーカウンターやアート展示スペースがあります。",
          "spot": {
            "id": "S100",
            "name": {
              "formatted": "コーヒー専門店 銀座３丁目店"
            },
            "address": {
              "formatted": "〒104-0061 東京都中央区銀座３丁目７-１"
            },
            "location": {
              "latitude": "37.416343",
              "longitude": "-122.153013"
            }
          },
          "location": {
            "latitude": "37.416343",
            "longitude": "-122.153013"
          },
          "numComments": "3",
          "numFavorites": "5",
          "favorited": false,
          "created" : "2010-11-02T10:42:57+09:00"
        },
        ...
    ]
}

※”startIndex”, “totalResults”はレスポンスに含まれません。
※”favorites”, “comments”フィールドは返却可能な期間や件数に制限があります。そのため全件が常にどのフィードでも返されるわけでありません。通常は過去数カ月間のフィードそれぞれに最新数件程度の結果が返されます。

あるチェックインの取得

リクエスト仕様

あるチェックインを取得するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/checkins/[User-ID]/@self/[Checkin-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID
Checkin-ID 取得したいチェックインを特定するためのID

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –

レスポンス仕様

取得結果は以下のようになります。含まれる情報はチェックイン履歴オブジェクトになります。

{
  "id": "1FZ3P4ACUWBBC-2010061010321",
  "user": {
    "id" : "1FZ3P4ACUWBB",
    "displayName" : "Becky",
    "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
    "profileUrl" : "http://mixi.jp/show_friend.pl?uid=1FZ3P4ACUWBB"
  },
  "message": "銀座３丁目店の2階にはコーヒーバーカウンターやアート展示スペースがあります。",
  "spot": {
    "id": "S100",
    "name": {
      "formatted": "コーヒー専門店 銀座３丁目店"
    },
    "address": {
      "formatted": "〒104-0061 東京都中央区銀座３丁目７-１"
    },
    "location": {
      "latitude": "37.416343",
      "longitude": "-122.153013"
    }
  },
  "location": {
    "latitude": "37.416343",
    "longitude": "-122.153013"
  },
  "numComments": "3",
  "numFavorites": "5",
  "favorited": false,
  "created" : "2010-11-02T10:42:57+09:00"
}

あるスポットにチェックイン

リクエスト仕様

あるスポットにチェックインするためのURIは、以下となります。

POST https://api.mixi-platform.com/2/checkins/[Spot-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
Spot-ID チェックインするスポットのID

リクエスト・ボディの指定方法には以下の二通りがあります。写真つきでチェックインを投稿するためには”multipart/form-data”形式を使用する必要があります。

“application/json”

Content-Typeリクエスト・ヘッダに”application/json”を指定し、リクエスト・ボディにて以下の内容をJSON形式で送信します。
文字エンコーディングはUTF-8またはContent-Typeリクエスト・ヘッダのcharsetで指定します。ただし、emojiCarrier, emojiCharsetが指定されている場合は、そちらが優先されます。

フィールド名 タイプ 内容 必須/任意 デフォルト値
location Location チェックインの位置情報 任意 (指定したスポットの位置)
message String チェックインの本文 任意 “”
privacy Privacy この投稿の公開範囲指定 任意 (友人まで公開)

<例>

{
    "message": "チェックインします",
    "location": {
        "latitude": "37.416343",
        "longitude": "-122.153013"
    },
    "privacy" : {
        "visibility" : "friends_of_friends",
    }
}

“multipart/form-data”

Content-Typeリクエスト・ヘッダに”multipart/form-data”を指定し、リクエストボディには以下のパラメータを指定します。

フィールド名 タイプ 内容 必須/任意 デフォルト値
request String application/jsonの場合に指定できるJSON文字列 必須 (前述)
photo Bytes 写真のバイナリデータ 任意 - 
boundary文字列
Content-Disposition: form-data; name="request"

{
  "message": "チェックインします",
  "location": {
    "latitude": "37.416343",
    "longitude": "-122.153013"
  },
  "privacy" : {
    "visibility" : "friends_of_friends",
  }
}
boundary文字列
Content-Disposition: form-data; name="photo"; filename="添付画像.jpg"
Content-Type: image/jpeg

.......添付画像のバイナリデータ

レスポンス仕様

マイスポットの作成に成功した場合は、HTTPステータスコード201が返却されます。
レスポンス・ボディは以下の内容を含むJSONになります。

フィールド名 タイプ 内容 必須/任意 デフォルト値 例
id String チェックインのID 必須 – “1FZ3P4ACUWBBC-2010061010321″ 
{
    "id": "1FZ3P4ACUWBBC-2010061010321"
}

あるチェックインの削除

リクエスト仕様

チェックインを削除するためのURIは、以下となります。

DELETE https://api.mixi-platform.com/2/checkins/[User-ID]/@self/[Checkin-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”
Checkin-ID 対象チェックインのID

レスポンス仕様

削除に成功した場合は、HTTPステータスコード200が返却されます。

HTTP/1.1 200 OK

機能一覧 (コメント/イイネ)

あるチェックインへのコメント一覧の取得

リクエスト仕様

あるチェックインへのコメント一覧を取得するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/checkins/comments/[User-ID]/@self/[Checkin-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID
Checkin-ID 対象チェックインのID

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –
startIndex 開始インデックス 任意 0
count 取得件数 任意 20

レスポンス仕様

取得結果は以下のようになります。個々のエントリに含まれる情報はコメントオブジェクトになります。

{
    "startIndex": 0,
    "itemsPerPage": 20,
    "totalResults": 1,
    "entry": [
        {
            "id": "sa1pzkdg9emdd-500000004743798-sa1pzkdg9emdd-20101208110507",
            "created" : "2010-12-08T11:07:38+09:00",
            "text" : "コメントです",
            "user": {
                "id" : "1FZ3P4ACUWBB",
                "displayName" : "Becky",
                "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
                "profileUrl" : "http://mixi.jp/show_friend.pl?uid=1FZ3P4ACUWBB"
            }
        }
    ]
}

コメントの投稿ユーザについて

あるコメントの投稿ユーザが認可ユーザと友人関係ではなかった場合、 user.id と user.displayName のみが結果として返却されます。

あるチェックインへのコメント投稿

リクエスト仕様

コメントを投稿するためのURIは、以下となります。

POST https://api.mixi-platform.com/2/checkins/comments/[User-ID]/@self/[Checkin-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID
Checkin-ID 対象チェックインのID

Content-Typeリクエスト・ヘッダに”application/json”を指定し、リクエスト・ボディにて以下の内容をJSON形式で送信します。
文字エンコーディングはUTF-8またはContent-Typeリクエスト・ヘッダのcharsetで指定します。ただし、emojiCarrier, emojiCharsetが指定されている場合は、そちらが優先されます。

フィールド名 タイプ 内容 必須/任意 デフォルト値
text String コメント本文 必須 –

<例>

{
    "text" : "コメントです"
}

レスポンス仕様

コメントの投稿に成功した場合は、HTTPステータスコード201が返却されます。
レスポンス・ボディは以下の内容を含むJSONになります。

フィールド名 タイプ 内容 必須/任意 デフォルト値 例
id String コメントのID 必須 – “sa1pzkdg9emdd-500000004743798-sa1pzkdg9emde-20101208110400″

<例>

{
    "id": "sa1pzkdg9emdd-500000004743798-sa1pzkdg9emde-20101208110400"
}

あるチェックインへのコメント削除

リクエスト仕様

コメントを削除するためのURIは、以下となります。

DELETE https://api.mixi-platform.com/2/checkins/comments/[User-ID]/@self/[Checkin-ID]/[Comment-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID
Checkin-ID 対象チェックインのID
Comment-ID 削除するコメントの ID

レスポンス仕様

削除に成功した場合は、HTTPステータスコード200が返却されます。

HTTP/1.1 200 OK

あるチェックインへのイイネ一覧の取得

リクエスト仕様

あるチェックインへのイイネ一覧を取得するためのURIは、以下となります。

GET https://api.mixi-platform.com/2/checkins/favorites/[User-ID]/@self/[Checkin-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザのユーザID、認可ユーザ自身を示す”@me”、または友人のユーザID
Checkin-ID 対象チェックインのID

このURIは以下のクエリ・パラメータを受け付けます。

パラメータ名 説明 必須/任意 デフォルト
fields 取得したい情報の項目をカンマ区切りで指定します 任意 –
startIndex 開始インデックス 任意 0
count 取得件数 任意 20

レスポンス仕様

取得結果は以下のようになります。個々のエントリに含まれる情報はイイネオブジェクトになります。

{
    "startIndex": 0,
    "itemsPerPage": 20,
    "totalResults": 1,
    "entry": [
        {
            "id" : "1FZ3P4ACUWBB",
            "displayName" : "Becky",
            "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
            "profileUrl" : "http://mixi.jp/show_friend.pl?uid=1FZ3P4ACUWBB",
            "created" : "2010-11-02T10:42:57+09:00"
        }
    ]
}

イイネの投稿ユーザについて

あるイイネの投稿ユーザが認可ユーザと友人関係ではなかった場合、 user.id と user.displayName のみが結果として返却されます。

あるチェックインへのイイネ投稿

リクエスト仕様

イイネを投稿するためのURIは、以下となります。

POST https://api.mixi-platform.com/2/checkins/favorites/[User-ID]/@self/[Checkin-ID]

URIのパスに含まれるパラメータは以下のとおりです。

パラメータ名 指定する値
User-ID 認可ユーザの友人のユーザID
Checkin-ID 対象チェックインのID

レスポンス仕様
イイネの投稿に成功した場合は、HTTPステータスコード201が返却されます。
レスポンス・ボディは以下の内容を含むJSONになります。

フィールド名 タイプ 内容 必須/任意 デフォルト値 例
id String イイネしたユーザの ID 必須 – “sa1pzkdg9emdd”

<例>

{
    "id": "sa1pzkdg9emdd"
}

あるチェックインへのイイネ削除

リクエスト仕様

イイネを削除するためのURIは、以下となります。

DELETE https://api.mixi-platform.com/2/checkins/favorites/[User-ID]/@self/[Checkin-ID]/[Favorite-User-ID]
パラメータ名 指定する値
User-ID 認可ユーザの友人のユーザID
Checkin-ID 対象チェックインのID
Favorite-User-ID 削除するイイネのID

レスポンス仕様

削除に成功した場合は、HTTPステータスコード200が返却されます。

HTTP/1.1 200 OK

このページの上部へ

Copyright (C) mixi, Inc. All rights reserved.