OpenPNE API 仕様

オリジナルドキュメントは、こちらです 最終更新日：2006/09/03

OpenPNE APIとは、 SNSサーバ上にある認証情報およびSNSのデータを、外部サーバに対してHTTP通信により提供するためのAPIである。 認証情報とは、 SNSサーバでユーザが認証済みである事を示す情報である。 SNSのデータとは、 OpenPNE SNS側のサーバのデータベースに保存されているデータを指す。 例えば、「ニックネーム」「プロフィール写真のURL」「フレンドリスト」などである。 外部サーバとは、 SNSサーバから認証情報とSNSのデータを取得し、SNSとは独立したサービスを提供するサーバである。

SNSサーバ(APIサーバ) ⇔ 外部サーバ(APIクライアント) 間のサーバ間通信

XML-RPCの仕様に準拠。文字コード系はUTF-8とする。

SNSサーバ、外部サーバ間のAPI通信に対しては、SNSサーバ側(OpenPNEアプリケーション)でIP制限を行う

SNSサーバ側で認証済みのユーザに対して、以下の値を埋め込んだ外部サーバへのリンクを生成する セッションID(後述) メンバーID リンク生成日時(YYYYMMDDHHMMSS形式) 外部サーバ側は、受け取ったリクエストをSNSサーバへAPI通信で送る (リンク生成日時が古いものは外部サーバ側で弾いてもよい) SNSサーバ側は、外部サーバから受け取ったリクエストを検証し結果を返す

APIトークン(SNS側の設定ファイで設定した文字列) メンバーID メンバートークン(後述) リンク生成日時(YYYYMMDDHHMMSS形式) を文字列連結したものをmd5でハッシュ化する。 $session_id = md5($api_token . $c_member_id . $c_member_token . $datetime);

メンバーに紐付く値で、SNSサーバが保持する。

値はメンバーがSNSにログインする毎に変更する。

URL例 http://app.example.net/entry?sid=b51a44e6a82cc0d6be9ecadea513c618&mid=237&dt=20060326032450

リクエスト例

POST URI 
http://sns.example.com/?m=api&a=do_xmlrpc 
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>000_auth</methodName>
<params>
<param>
<value><struct>
<member><name>sid</name>
<value><string>b51a44e6a82cc0d6be9ecadea513c618</string></value>
</member>
<member><name>mid</name>
<value><int>237</int></value>
</member>
<member><name>dt</name>
<value><string>20060326032450</string></value>
</member>
</struct></value>
</param>
</params>
</methodCall>

PHPコード例

<?php
require_once "XML/RPC.php";
...
$params = array(
    "sid" => strval($sid),
    "mid" => intval($mid),
    "dt"  => strval($dt),
);
$params = array(XML_RPC_encode($params));
$msg = new XML_RPC_Message("000_auth", $params);

$cli = new XML_RPC_Client("/?m=api&a=do_xmlrpc", "sns.example.com");
$cli->send($msg);
...
?>

レスポンス例（成功） メンバーIDを返す。

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
     <value><int>237</int></value>
    </param>
  </params>
</methodResponse>

レスポンス例（失敗）（ユーザが正常登録状態にない場合）

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<fault>
  <value>
    <struct>
      <member>
        <name>faultCode</name>
        <value><int>51</int></value>
      </member>
      <member>
        <name>faultString</name>
        <value><string></string></value>
      </member>
    </struct>
  </value>
</fault>
</methodResponse>

methodName 説明 001_get_c_member メンバー情報取得 ... ...

リクエスト

リクエスト例 3番のメンバーが10番のメンバーを見た場合

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>001_get_c_member</methodName>
<params>
<param>
<value><struct>
<member><name>target_c_member_id</name>
<value><int>10</int></value>
</member>
<member><name>my_c_member_id</name>
<value><int>3</int></value>
</member>
</struct></value>
</param>
</params>
</methodCall>

PHPコード例

<?php
require_once "XML/RPC.php";
...
$params = array(
	"target_c_member_id" => intval($target_c_member_id),
	"my_c_member_id"     => intval($my_c_member_id),
);
$params = array(XML_RPC_encode($params));
$msg = new XML_RPC_Message("001_get_c_member", $params);

$cli = new XML_RPC_Client("/?m=api&a=do_xmlrpc", "sns.example.com");
$cli->send($msg);
...
?>

レスポンス

date: YYYYMMDDHHMMSS

レスポンス例

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
  <value>
    <struct>
      <member>
        <name>c_member_id</name>
        <value><int>10</int></value>
      </member>
      <member>
        <name>nickname</name>
        <value><string>ハチス</string></value>
      </member>
      <member>
        <name>image_url</name>
        <value>
          <string>http://sns.example.com/img.php?filename=m_10_1133710936.jpg</string>
        </value>
      </member>
      <member>
        <name>birth_year</name>
        <value><int>1982</int></value>
      </member>
      <member>
        <name>birth_month</name>
        <value><int>2</int></value>
      </member>
      <member>
        <name>birth_day</name>
        <value><int>15</int></value>
      </member>
      <member>
        <name>access_date</name>
        <value><string>20060116113706</string></value>
      </member>
      <member>
        <name>r_date</name>
        <value><string>20050817000000</string></value>
      </member>
      <member>
        <name>profile</name>
        <value>
          <struct>
            <member>
              <name>sex</name>
              <value><string>男性</string></value>
            </member>
            <member>
              <name>blood_type</name>
              <value><string>o</string></value>
            </member>
            <member>
              <name>pre_addr_pref</name>
              <value><string>東京都</string></value>
            </member>
            <member>
              <name>old_addr_pref</name>
              <value><string>埼玉県</string></value>
            </member>
            <member>
              <name>self_intro</name>
              <value><string>演劇サークルに入りました。12/14-18に初舞台です。
毎日稽古で忙しいです。合間をぬって出社します。</string></value>
            </member>
          </struct>
        </value>
      </member>
    </struct>
  </value>
</param>
</params>
</methodResponse>

リクエスト URI http://sns.example.com/?m=api&a=do_xmlrpc encoding UTF-8 methodName 101_add_point parameters 要素名 型 説明 c_member_id * int ポイント操作対象のc_member_id point * int ポイント増分(負の数の場合は減算) tags array タグ情報(複数指定可能) memo string メモ * : 必須項目 レスポンス 成功した場合、総ポイント残高を返す。 失敗した場合、エラーコードとエラーメッセージを返す。

リクエスト URI http://sns.example.com/?m=api&a=do_xmlrpc encoding UTF-8 methodName 002_get_member_point parameters 要素名 型 説明 c_member_id * int ポイント照会対象のc_member_id * : 必須項目 レスポンス 成功した場合、総ポイント残高を返す。 失敗した場合、エラーコードとエラーメッセージを返す。

リクエストパラメータに不足がある場合

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<fault>
  <value>
    <struct>
      <member>
        <name>faultCode</name>
        <value><int>3</int></value>
      </member>
      <member>
        <name>faultString</name>
        <value><string>Incorrect parameters passed to method: Signature permits 1 parameters but the request had 0</string></value>
      </member>
    </struct>
  </value>
</fault>
</methodResponse>

• XML-RPC Specification http://www.xmlrpc.com/spec
• 同日本語版 http://lowlife.jp/yasusii/stories/9.html
• PEAR::XML_RPC http://pear.php.net/manual/ja/package.webservices.xml-rpc.php