このサイトについて

このサイトでは、OpenPNE3.8から新たに追加された、JSON APIについてまとめています。

スマートフォンAPIの使い方

スマートフォンAPIはとても簡単に使えます。一番簡単なサンプルを紹介します。

0. OpenPNEにログインする

スマートフォンAPIにアクセスするためには、OpenPNEにログインしておく必要があります。まずはブラウザからアクセスし、OpenPNEにログインします。

1. APIキーを取得する

APIにアクセスする際には、APIキーが必要になります。

APIキーはログイン後のすべてのHTMLコードの中に書かれていますので、それを使用 します。

2. APIを呼び出す

ターミナルからcurlコマンドを利用するか、あるいはブラウザで以下のURLに直接ア クセスしてみましょう。

##APIKEY##の部分を1.で取得したAPIキーに置き換えてください。

$ curl http://example.com/sns/api.php/activity/search.json?apiKey=##APIKEY##

3. JSON形式のデータを取得する

スマートフォンAPIから返答されるAPIレスポンスはJSON形式です。以下のようなデ>ータ構造になります。（ActivityDataの場合）

{
"status": "success",
"data": [{
    "id": "7",
    "member": {
        "id": "2",
        "profile_image": "http://houou02.local.jp/images/no_image.gif",
        "screen_name": "kashiwasan",
        "name": "kashiwasan",
        "profile_url": "http://houou02.local.jp/member/2",
        "friend": false,
        "blocking": false,
        "self": true,
        "friends_count": 0,
        "self_introduction": null
    },
    "body": "@kashiwasan メンションを飛ばすことができる。",
    "body_html": "<a target="_blank" href="http://houou02.local.jp/member/2">@kashiwasan</a> メンションを飛ばすことができる。",
    "uri": null,
    "source": null,
    "source_uri": null,
    "created_at": "Wed, 08 Feb 2012 16:31:03 +0900"
}, ]
}

もっと詳しく知るには？

ファーストステップガイド で、APIの使い方を分かりやすくチュートリアルしています。