nucleus/documentation/devdocs/xmlrpc.html

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="ja-JP" xml:lang="ja-JP">\r
   4 <head>\r
   5         <!--\r
   6                 Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)\r
   7                 Copyright (C) 2002-2012 The Nucleus Group\r
   8 \r
   9                 This program is free software; you can redistribute it and/or\r
  10                 modify it under the terms of the GNU General Public License\r
  11                 as published by the Free Software Foundation; either version 2\r
  12                 of the License, or (at your option) any later version.\r
  13                 (see nucleus/documentation/index.html#license for more info)\r
  14         -->\r
  15         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
  16     <meta http-equiv="Content-Style-Type" content="text/css" />\r
  17     <meta http-equiv="Content-Script-Type" content="text/javascript" />\r
  18     <link rel="index" href="./index.html" />\r
  19         <title>Nucleus - XML-RPC インターフェイス</title>\r
  20         <link rel="stylesheet" type="text/css" href="styles/manual.css" />\r
  21     <style type="text/css">\r
  22         strong {\r
  23             font-weight: bold;\r
  24         }\r
  25         em {\r
  26             font-style: italic;\r
  27         }\r
  28     </style>\r
  29         <script src="http://www.google.com/jsapi"></script>\r
  30         <script type="text/javascript">\r
  31                 google.load("jquery", "1");\r
  32                 google.setOnLoadCallback(function() {\r
  33                         $.getScript("javascript/fontsizeChanger.js");\r
  34                 });\r
  35         </script>\r
  36 </head>\r
  37 <body>\r
  38         <div id="fontSizeChanger">\r
  39         <a href="#top" id="f_small">小</a>\r
  40         <a href="#top" id="f_medium">中</a>\r
  41         <a href="#top" id="f_large">大</a>\r
  42         </div>\r
  43 <div id="body">\r
  44 \r
  45 <div class="heading">\r
  46 XML-RPC インターフェイス\r
  47 </div>\r
  48 \r
  49 <h1>はじめに</h1>\r
  50 \r
  51 <p>\r
  52 <a href="index.html">開発者マニュアルに戻る</a>\r
  53 </p>\r
  54 \r
  55 <p>\r
  56 このドキュメントはNucleusが提供するXML-RPCインターフェイスと、生成される<a href="#errorcodes">エラーメッセージ</a>についての解説です。この仕様は将来変更される可能性があることに注意して下さい。\r
  57 </p>\r
  58 \r
  59 <div class="note">\r
  60 NucleusにおけるXML-RPCインターフェイスのURLは以下のようになります：\r
  61 <br />\r
  62 <strong>http://www.yourserver.com/yourpath/nucleus/xmlrpc/server.php</strong>\r
  63 </div>\r
  64 \r
  65 <h1><a name="bloggerApi" id="bloggerApi">Blogger API (XML-RPC)</a></h1>\r
  66 \r
  67 <p>\r
  68 Nucleusは<a href="http://www.blogger.com/developers/api/1_docs/">Blogger API</a>に対応しています。これはBloggerと通信するツールやサービスに対して、Nucleusとも通信できるようにするものです。Nucleusの仕様により、いくつかのパラメータに若干の違いがあります。これについては後述の説明を参照して下さい。呼び出しや応答のメソッドは、もちろん、Bloggerのものと同じ構造になっています。\r
  69 </p>\r
  70 \r
  71 <p>\r
  72 ここに挙げたリストは利用できるメソッドの一覧です。クリックするとさらに詳しい情報を得ることができます（それぞれのリンク先はBlogger APIの仕様書やその<a href="http://groups.yahoo.com/group/bloggerDev">メーリングリスト</a>です）。\r
  73 </p>\r
  74 \r
  75 <ul>\r
  76         <li><strong><a href="http://www.blogger.com/developers/api/1_docs/xmlrpc_newPost.html">blogger.newPost</a></strong></li>\r
  77         <li><strong><a href="http://www.blogger.com/developers/api/1_docs/xmlrpc_editPost.html">blogger.editPost</a></strong></li>\r
  78         <li><strong><a href="http://groups.yahoo.com/group/bloggerDev/message/296">blogger.getPost</a></strong></li>\r
  79         <li><strong><a href="http://groups.yahoo.com/group/bloggerDev/message/147">blogger.deletePost</a></strong></li>\r
  80         <li><strong><a href="http://www.blogger.com/developers/api/1_docs/xmlrpc_getUsersBlogs.html">blogger.getUsersBlogs</a></strong></li>\r
  81         <li><strong><a href="http://groups.yahoo.com/group/bloggerDev/message/225">blogger.getRecentPosts</a></strong></li>\r
  82         <li><strong><a href="http://groups.yahoo.com/group/bloggerDev/message/315">blogger.getUserInfo</a></strong></li>\r
  83         <li><strong><a href="http://www.blogger.com/developers/api/1_docs/xmlrpc_getTemplate.html">blogger.getTemplate</a></strong></li>\r
  84         <li><strong><a href="http://www.blogger.com/developers/api/1_docs/xmlrpc_setTemplate.html">blogger.setTemplate</a></strong></li>\r
  85 </ul>\r
  86 \r
  87 \r
  88 <p>\r
  89 Nucleusは内部的に異なる実装を用いているため、パラメータの扱いに若干の違いがあります。概説すると：\r
  90 </p>\r
  91 \r
  92 <ul>\r
  93         <li>Appkeyは無視されます。</li>\r
  94         <li>Nucleusの場合は本文のあとにタイトルとカテゴリが続きます。Bloggerでは 'コンテンツ' と呼ばれるは本文だけが存在します。これらの追加されたパーツを利用可能にするため、<samp>&lt;title&gt;</samp>や<samp>&lt;category&gt;</samp>をNucleusに送るコンテンツに含めることができます。これらのタグは getRecentPosts の呼び出しでのみ追加されます。</li>\r
  95         <li>Bloggerで 'templates' と呼ばれているものに相当するのが、Nucleusの 'スキン' です。ひとつのシステムに複数のスキンを設定でき、それぞれのスキンをblogごとに使い分けることができます。メソッド blogger.setTemplate と blogger.getTemplate は、Nucleusのblog設定で選択されているblogのデフォルトスキンに影響します。'main' と 'archiveIndex' の二種類のテンプレートは、Nucleusの 'メインの目次ページ' と '月別アーカイブ一覧ページ' に相当します。（<em>訳注： Blogger の仕様がわからないので、この項不確か</em>)</li>\r
  96         <li>項目 <code>publish</code> は、追加した項目がデフォルトでドラフトになるか公開になるかを決める箇所です。<code>blogger.editPost</code> を使う場合は、<code>publish</code> がドラフトと公開のどちらになっていても無視されます。</li>\r
  97         <li><code>getUserInfo</code> を呼び出した場合、返値のうち 'lastname' は空になり、'firstname' にフルネームが入ります。これはNucleusが姓と名を分けない仕様になっていることに由来します。</li>\r
  98         <li>メソッド <code>getRecentPostst</code> は <code>authorName</code> と <code>title</code> を追加パラメータとして返します。Bloggerもまたこれらの値を返します（この仕様は文書化されていないようですが）。</li>\r
  99 </ul>\r
 100 \r
 101 <h1><a id="metaweblog" name="metaweblog">metaWeblog API</a></h1>\r
 102 \r
 103 <p>\r
 104 Nucleus v1.1以降、<a href="http://www.xmlrpc.com/metaWeblogApi">metaWeblog API</a>もサポートされました。これはBlogger APIの拡張版です。 \r
 105 </p>\r
 106 \r
 107 <p>Nucleus v2.5では <code>newMediaObject</code> と <code>getRecentPosts</code> の二つのメソッドにも対応しました（これらは最初のmetaWeblog仕様には存在しませんでした）。</p>\r
 108 \r
 109 <p>\r
 110 利用可能なメソッド一覧は以下の通りです（<a href="http://www.xmlrpc.com/metaWeblogApi">specification</a>に詳しい情報があります）：\r
 111 </p>\r
 112 \r
 113 <ul>\r
 114         <li>metaWeblog.newPost</li>\r
 115         <li>metaWeblog.editPost</li>\r
 116         <li>metaWeblog.getPost</li>\r
 117         <li>metaWeblog.getCategories</li>\r
 118         <li>metaWeblog.newMediaObject (v2.5)</li>\r
 119         <li>metaWeblog.getRecentPosts (v2.5)</li>\r
 120 </ul>\r
 121 \r
 122 <p>Nucleus v3.22以降、<code>mt_text_more</code> と <code>m_tallow_comment</code>もサポートされました。これはmetaWeblog API の拡張版です。つまりこれらの拡張機能をサポートするアプリケーション、例えば Ectoなど、を使用した場合、「続き」を編集することができ、アイテムにコメントを許可するかどうかを決定することができるようになる、ということです。</p>\r
 123 \r
 124 <h1><a name="mtApi" id="mtApi">Movable Type API</a></h1>\r
 125 \r
 126 <p>v2.5から、Nucleusは<a href="http://www.movabletype.org/docs/mtmanual_programmatic.html">Movable Type API</a>からのメソッドをサポートするようになりました。</p>\r
 127 \r
 128 <p>利用できるメソッドの一覧を以下に示します：</p>\r
 129 \r
 130 <ul>\r
 131         <li>mt.supportedMethods</li>\r
 132         <li>mt.supportedTextFilters</li>\r
 133         <li>mt.publishPost</li>\r
 134         <li>mt.getCategoryList</li>\r
 135         <li>mt.getPostCategories</li>\r
 136         <li>mt.setPostCategories</li>\r
 137         <li>mt.getRecentPostTitles</li>\r
 138         <li>mt.getTrackbackPings</li>\r
 139 </ul>\r
 140 \r
 141 <p>いくつかのノート：</p>\r
 142 \r
 143 <ul>\r
 144         <li>Nucleusはアイテムひとつにつき一つだけカテゴリを設定することができます。これは 'primary' 以外のカテゴリ設定項目はすべて無視されることを意味します。</li>\r
 145         <li>トラックバックはNucleusのコアではサポート対象外です（プラグインの導入によって利用することができるようになります）。このため、<code>mt.getTrackbackPings</code> のデフォルトの返値は空です。</li>\r
 146         <li>Nucleusはテキストフィルタを実装していません。このため、<code>mt.getSupportedTextFilters</code> は空の値を返します。</li>\r
 147 </ul>\r
 148 \r
 149 <h1><a id="errorcodes" name="errorcodes">エラーコード</a></h1>\r
 150 \r
 151 <p>\r
 152 以下に示すのは、それぞれのメソッドから得られるエラーの種類です：\r
 153 </p>\r
 154 \r
 155 <table summary="エラーコード と エラーメッセージ">\r
 156         <tr>\r
 157                 <th abbr="エラーコード">エラーコード</th>\r
 158                 <th abbr="エラーメッセージ">エラーメッセージ</th>\r
 159         </tr>\r
 160         <tr>\r
 161                 <td>801</td>\r
 162                 <td>Login Error <br />\r
 163                 ログインエラー（ユーザ名とパスワードの組み合わせが正しくないと推測されます）</td>\r
 164         </tr>\r
 165         <tr>\r
 166                 <td>802</td>\r
 167                 <td>No Such Blog<br />\r
 168                 指定されたBlogは存在しません</td>\r
 169         </tr>\r
 170         <tr>\r
 171                 <td>803</td>\r
 172                 <td>Not a Team Member<br />\r
 173                 チームに登録されていません</td>\r
 174         </tr>\r
 175         <tr>\r
 176                 <td>804</td>\r
 177                 <td>Cannot add Empty Items<br />\r
 178                 空のアイテムは投稿できません</td>\r
 179         </tr>\r
 180         <tr>\r
 181                 <td>805</td>\r
 182                 <td>Amount parameter must be in range 1..20<br />\r
 183                 パラメータの値は 1..20 の範囲でなければなりません（<em>getRecentItems</em></td>\r
 184         </tr>\r
 185         <tr>\r
 186                 <td>806</td>\r
 187                 <td>No Such Item<br />\r
 188                 指定されたアイテムは存在しません</td>\r
 189         </tr>\r
 190         <tr>\r
 191                 <td>807</td>\r
 192                 <td>Not Allowed to Alter Item<br />\r
 193                 アイテム追加の権限がありません</td>\r
 194         </tr>\r
 195         <tr>\r
 196                 <td>808</td>\r
 197                 <td>Invalid media type<br />\r
 198                 メディアタイプが不正です</td>\r
 199         </tr>\r
 200         <tr>\r
 201                 <td>809</td>\r
 202                 <td>File is too large<br />\r
 203                 ファイルが大きすぎます（最大のアップロードファイルサイズ）</td>\r
 204         </tr>           \r
 205         <tr>\r
 206                 <td>810</td>\r
 207                 <td>Other error on newMediaObject<br />\r
 208                 newMediaObject で予期せぬエラーが発生しました（何が起きたのかもう少し情報が含まれるでしょう）</td>\r
 209 \r
 210         </tr>\r
 211         <tr>\r
 212                 <td><em>その他のコード &lt; 100</em></td>\r
 213                 <td>Errors encountered by the Useful Inc. XML-RPC implementation<br />\r
 214                 Usefil Inc. XML-RPC の実行でエラーが発生しました</td>\r
 215         </tr>\r
 216         <tr>\r
 217                 <td><em>その他のコード &gt; 100</em></td>\r
 218 \r
 219                 <td>Errors encountered by the XML parser<br />\r
 220                 XML パーサでエラーが発生しました</td>\r
 221         </tr>\r
 222 \r
 223 \r
 224 </table>\r
 225 \r
 226 </div>\r
 227 \r
 228 </body>\r
 229 </html>