mixi Connect » mixi Graph API » 技術仕様 » Check API
Check API
mixi Pluginにて提供されているmixiチェックボタンをWebサイトに設置することで、ユーザはコメント付きでそのページと感情を友人と共有することができるようになります。しかし、ユーザにmixiチェックボタンを押してもらうのではなく、そのWebページ上でのユーザの行動の結果として、暗黙的にチェックの投稿を行いたい場面もあることでしょう。
そのようなケースでは、mixi Graph APIにて提供されるCheck APIを利用することで実現可能です。ここでは、Check APIの使用方法について説明します。
事前に必要なもの
mixi チェック投稿 API を利用するためには、以下の情報をすでに入手している必要があります。
- mixi チェック識別キー
- “w_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はオブジェクトをひとつだけ含み、そのオブジェクトのプロパティには、以下の表のものを指定します。
| パラメータ名 | 説明 | 備考 |
|---|---|---|
| key | mixi チェック識別キーを指定します | 必須 |
| privacy | 公開範囲を指定します | 指定されていない場合、mixi チェックのデフォルト公開範囲で設定されます |
| title | タイトル。チェックする対象を簡潔に表す文字列です | 必須 |
| description | チェックする対象の説明文 | |
| comment | ユーザの入力したコメント | |
| content_rating | 18 歳未満非対応の場合は “1″ | |
| image | サムネイル画像の URL | |
| primary_url | この投稿が参照する URL (*1) | 必須 |
| pc_url | PC 向けページの URL | |
| smartphone_url | スマートフォン向けページの URL | |
| mobile_url | 携帯電話（すべてのキャリア）向けページの URL | (*2) |
| mobile_docomo_url | 携帯電話（DoCoMo）向けページの URL | (*2) |
| mobile_au_url | 携帯電話（au）向けページの URL | (*2) |
| mobile_softbank_url | 携帯電話（softbank）向けページの URL | (*2) |
(*1) primary_url は「チェックされた対象」を識別するために使われます。個別のチェックのうち、primary_url が同じものは、同じ対象をチェックしたものとして扱われます。
(*2) モバイルページでも表示したい場合は、携帯電話向けページの URL のうち、少なくともひとつを指定してください。
それぞれの属性値の詳細および制限については、特に言及がない限り、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