mixiアプリ » 技術仕様（RESTful API方式） » リファレンス » RESTful API » Person & Friends API
Person & Friends API
ユーザのプロフィールや友人の情報を取得することができます。
プロフィール情報の取得
自分自身、または友人のプロフィール情報を取得します。
エンドポイントURL
GET http://api.mixi-platform.com/os/0.8/people/{guid}/{selector}/{pid}
Templateパラメータ
| パラメータ | 説明 | 必須 | 備考 |
|---|---|---|---|
| guid |
対象ユーザ。
|
○ | |
| selector |
guid のユーザー本人かその友人かを選択。
|
○ | |
| pid |
ユーザIDを指定。 |
selector に @friends を指定のときのみ有効 |
クエリパラメータ
| パラメータ | 説明 | 必須 | 備考 |
|---|---|---|---|
| fields |
結果に含めたいフィールドのリスト |
複数指定はカンマ区切り | |
| filterBy |
指定されたフィールドでフィルタされます（hasAppのみ対応）
|
※共通クエリパラメータを使用できます。
レスポンスのデータ構造
json 形式
| property | 説明 | 型 | 備考 |
|---|---|---|---|
| entry | ユーザ情報オブジェクト | object | selector に @friends 指定のときはユーザ情報オブジェクトの配列 |
| startIndex | 取得開始インデックス | integer | |
| itemsPerPage | 1ページあたりの件数 | integer | selector が @friends のときのみ付与 |
| totalResults | 条件に一致した総件数 | integer |
ユーザ情報
| property | 説明 | 型 | 備考 |
|---|---|---|---|
| id | ユーザID | string | |
| nickname | ニックネーム | string | |
| displayName | 表示名 | string | |
| updated | 更新日時 | string | |
| hasApp | アプリ利用状態 | boolean | |
| thumbnailUrl | プロフィール画像URL | string | |
| isViewer | Viewer かどうか | boolean | selector が @self のとき付与 |
| isOwner | Owner かどうか | boolean | selector が @self のとき付与 |
| profileUrl | プロフィールURL | string | fields に指定して取得 |
| bloodType | 血液型 A, AB, B, O のいずれか | string | fields に指定して取得 |
| addresses | 現住所 | array | fields に指定して取得 |
| birthday | 生年月日 | string | fields に指定して取得 |
| gender | 性別 | string | fields に指定して取得 |
| userHash | ユーザハッシュ | string | fields に指定して取得 |
| isGuest | ゲストプレイユーザかどうか | boolean | fields に指定して取得 |
| isVerified | SMS認証済ユーザかどうか | boolean |
fields に指定して取得 |
サンプル
自分自身のプロフィール情報を取得
リクエスト
GET http://api.mixi-platform.com/os/0.8/people/@me/@self
レスポンス
application/json 形式:
200 OK
{
"entry" : {
"thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/xxxxxxx_XXXXXXXXXXXs.jpg",
"nickname" : "ミクシィ開発部",
"isViewer" : "true",
"hasApp" : "true",
"isOwner" : "true",
"id" : "mixi.jp:xxxxxxx",
"updated" : "2009-06-01T12:11:31Z",
"displayName" : "ミクシィ開発部"
},
"startIndex" : 0,
"totalResults" : 1
}
友人のプロフィール情報を取得
リクエスト
GET http://api.mixi-platform.com/os/0.8/people/@me/@friends
レスポンス
application/json 形式:
200 OK
{
"entry" : [
{
"thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/xxxxxxxxxx_XXXXXXXXXs.jpg",
"nickname" : "ミクシィ開発部の友人1",
"id" : "mixi.jp:xxxxxxxxxx",
"updated" : "2015-09-01T09:27:37Z",
"hasApp" : "true",
"displayName" : "ミクシィ開発部の友人1"
},
{
"thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/xxxxxxxxxx_XXXXXXXXXs.jpg",
"nickname" : "ミクシィ開発部の友人2",
"id" : "mixi.jp:xxxxxxxxxx",
"updated" : "2015-09-01T09:27:37Z",
"hasApp" : "false",
"displayName" : "ミクシィ開発部の友人2"
}
],
"startIndex" : 0,
"itemsPerPage" : 50,
"totalResults" : 2
}
レスポンスコード
| コード | 説明 |
|---|---|
| 200 (OK) | 成功 |
| 400 (BAD_REQUEST) | ページング指定値が不正、認証情報が不正、取得対象IDが未指定 |
| 403 (FORBIDDEN) | 取得権限がない、セレクタ（@self, @friendsなど）が未指定 |
| 404 (NOT_FOUND) | 指定ユーザが見つからない、取得対象ユーザIDが不正 |
| 500 (INTERNAL_SERVER_ERROR) | mixi側の内部エラー |
参照
pc: http://developer.mixi.co.jp/appli/spec/pc/restful-api-for-pc/restful-api-details/
スマートフォン: http://developer.mixi.co.jp/appli/spec/touch/using_restful_api/restful-api-details/
モバイル: http://developer.mixi.co.jp/appli/spec/mob/mobile_api_detail/