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

mixi Pluginにて提供されているmixiチェックボタンをWebサイトに設置することで、ユーザはコメント付きでそのページと感情を友人と共有することができるようになります。しかし、ユーザにmixiチェックボタンを押してもらうのではなく、そのWebページ上でのユーザの行動の結果として、暗黙的にチェックの投稿を行いたい場面もあることでしょう。

そのようなケースでは、mixi Graph APIにて提供されるCheck APIを利用することで実現可能です。ここでは、Check APIの使用方法について説明します。

事前に必要なもの

mixi チェック投稿 API を利用するためには、以下の情報をすでに入手している必要があります。

• mixi チェック識別キー
• “w_share”または“r_share” スコープについて認可されたアクセストークン

mixiチェックに投稿を行う際には、mixiチェック識別キーを発行し事前に入手しておく必要があります。発行手順については、mixiチェック – サービス管理のページをご覧ください。

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

mixiチェックの投稿

mixiチェックの投稿を行うために、クライアントプログラムは”https://api.mixi-platform.com/2/share”にアクセスします。このURIは、以下の仕様となります。

POST https://api.mixi-platform.com/2/share

HTTPリクエストのリクエスト・ボディには、投稿内容をJSON形式で指定します。”Content-Type”ヘッダには、”application/json”とcharsetを指定します。例えばUTF-8 の場合は、”application/json; charset=utf-8″となります。

リクエスト・ボディに指定する投稿内容として、そのJSONはオブジェクトをひとつだけ含み、そのオブジェクトのプロパティには、以下の表のものを指定します。

コメント付きの場合とそうでない場合でhome画面での表示のされ方が異なります。
コメント付きの場合:
「スタンダード」タブ選択時「友人の発言」に表示されます
コメントがない場合:
「スタンダード」タブ選択時「友人の動き」に表示されます

※「スタンダード」タブ選択が使用できるのは、PC、mixiTouchです。
※公式クライアントアプリには「友人の発言」「友人の動き」という分類はありません。

(*1) primary_url は「チェックされた対象」を識別するために使われます。個別のチェックのうち、primary_url が同じものは、同じ対象をチェックしたものとして扱われます。
(*2) モバイルページでも表示したい場合は、携帯電話向けページの URL のうち、少なくともひとつを指定してください。
(*3) comment にはアプリケーション都合の文言は設定せずに、必ずユーザの入力値を設定するようにして下さい。 定型文やリンクの挿入は下記ガイドラインの「第6条 禁止事項」に抵触する可能性がありますのでご注意下さい。

mixi Platform利用規約
http://developer.mixi.co.jp/about-platform/policies/platform_terms/#toc-6

それぞれの属性値の詳細および制限については、特に言及がない限り、PC 向け仕様に準拠するものとします。

“privacy” パラメーターの形式

公開範囲を指定するための “privacy” パラメーターはオブジェクトで指定します。オブジェクトのプロパティには以下のものを指定できます。

visibility

必須。以下のいずれかを指定します。

• “friends_of_friends” : 友人の友人まで公開
• “friends” : 友人まで公開
• “top_friends” : 仲良しまで公開
• “group” : 特定のグループに公開
• “self” : 非公開

group

“visibility” に “group” を指定した場合は必須。公開する先のグループの ID を指定します。

• チェック投稿 API で指定できるグループはひとつだけです
• グループの ID はGroups APIで取得できます

HTTP リクエスト、レスポンスのサンプル

例えば、以下のような HTTP POST リクエストを送信します。

POST https://api.mixi-platform.com/2/share
Host: api.mixi-platform.com
Authorization: OAuth ...
Content-Length: 114
Content-Type: application/json; charset=utf8

{"primary_url":"http://example.com/index.html",
 "title":"My first check",
 "privacy":{"visibility":"friends"},
 "key":"daf74328ec4d34f74663b30c0ddd93bed7aa816d"}

投稿が正常に完了した場合は、ステータスコード 200 が返されます。

HTTP/1.1 200 OK

イイネ！された数を取得する

機能概要

イイネ！・チェックされた数を返すAPIです。取得するためのURIは以下となります。

GET https://api.mixi-platform.com/2/share?primaryUrl=http://demo.com/example.html

URIは以下のパラメータを受け付けます。

レスポンス仕様

正常に処理がおこなわれた結果は、以下のレスポンスをapplication/json形式で返します。 HTTPステータスコードは、200が返されます。

 例）

{
  "allCount": "16"
  "favoriteCount": "3",
  "checkCount": "5",
  "feedbackCount": "4",
  "commentCount": "4"
}