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

mixiアプリ

mixiアプリ » 技術仕様（RESTful API方式） » リファレンス » RESTful API » Persistence API

Persistence API

ユーザに紐付くデータをmixiサーバ上にKey-Value形式で格納します。

データ取得

ユーザに紐付くデータを取得します。

エンドポイントURL

GET http://api.mixi-platform.com/os/0.8/appdata/{guid}/{selector}/@app

Templateパラメータ

パラメータ説明必須備考
guid

ユーザを指定。
使用できる値は次のとおりです。

  • {guid}：ユーザID
  • @me：自分自身を表す
 ○
selector

guid で指定したユーザ本人か、その友人かを選択。
使用できる値は次のとおりです。

  • @selft：guid で指定したユーザのデータを取得
  • @friends：guid で指定したユーザの友人のデータを取得
 ○

クエリパラメータ

パラメータ説明必須備考
fields

取得する key を指定できます。
省略した場合はすべて取得します。

 複数指定はカンマ区切り

※共通クエリパラメータを使用できます。

レスポンスのデータ構造

json形式

プロパティ名説明型備考
entry 複数ユーザのデータオブジェクト object
entry.* 1ユーザのデータオブジェクト object プロパティ名は platformUserId
entry.*.* 保持する値 string プロパティ名は key
startIndex 取得開始インデックス integer
id[] platformUserId string
totalResults 条件に一致した総件数 integer

サンプル

リクエスト

GET http://api.mixi-platform.com/os/0.8/appdata/@me/@self/@app

レスポンス

application/json 形式:

200 OK

{
  "entry" : {
    "mixi.jp:xxxxxx" : {
      "subject" : "appdata subject: 80",
      "content" : "appdata content: 86",
      "updated" : "2009-02-13T18:30:02Z"
    }
  },
  "startIndex" : 0,
  "id" : ["mixi.jp:xxxxxx"],
  "totalResults" : 1
}

application/atom+xml 形式:

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:osearch="http://a9.com/-/spec/opensearch/1.1">
  <entry>
    <content type="application/xml">
      <appdata xmlns="http://ns.opensocial.org/2008/opensocial">
        <subject>appdata subject: 6</subject>
        <content>appdata content: 36</content>
        <updated>2009-02-13T18:30:02Z</updated>
      </appdata>
    </content>
    <title/>
    <updated/>
    <author>
      <url>urn:guid:mixi.jp:xxxxxxx</url>
    </author>
    <id>urn:guid:mixi.jp:xxxxxxx</id>
  </entry>
  <osearch:startIndex>0</osearch:startIndex>
  <osearch:totalResults>1</osearch:totalResults>
</feed>

データ登録

ユーザに紐付くデータを登録します。

エンドポイントURL

POST http://api.mixi-platform.com/os/0.8/appdata/{guid}/@self/@app

Templateパラメータ

パラメータ説明必須備考
guid

ユーザを指定。
使用できる値は次のとおりです。

  • {guid}：アプリ実行者のユーザID
  • @me：自分自身を表す
 ○ アプリ実行者のデータのみ登録できます。

リクエストパラメータ

パラメータ説明必須備考
{key} key-value形式で値を保存します ○ パラメータにkeyを指定

サンプル

リクエスト

POST http://api.mixi-platform.com/os/0.8/appdata/@me/@self/@app
 
{
  "sample_post_key" : "sample_post_value"
}

レスポンス

200 OK

データ削除

ユーザに紐付くデータを削除します。

エンドポイントURL

DELETE http://api.mixi-platform.com/os/0.8/appdata/{guid}/@self/@app

Templateパラメータ

パラメータ説明必須備考
guid

ユーザを指定。
使用できる値は次のとおりです。

  • {guid}：アプリ実行者のユーザID
  • @me：自分自身を表す
 ○ アプリ実行者のデータのみ削除できます。

リクエストパラメータ

パラメータ説明必須備考
fields

削除する key を指定。
省略した場合はすべて削除します。

 複数指定はカンマ区切り

サンプル

リクエスト

DELETE http://api.mixi-platform.com/os/0.8/appdata/@me/@self/@app

レスポンス

200 OK

レスポンスコード

コード発生する状況
200 (OK) 成功
400 (BAD_REQUEST)

Key/Value指定が不正、100個以上のKey/Value指定、
Keyとして許されない文字の使用、認証情報が不正、取得対象IDが未指定
403 (FORBIDDEN) 取得または更新権限がない、セレクタ(@self, @friendsなど)が未指定
500 (INTERNAL_SERVER_ERROR) mixi側の内部エラー

参照

モバイル: http://developer.mixi.co.jp/appli/spec/mob/mobile_api_detail/

このページの上部へ

©MIXI