XML-RPC API
Movable Typeは、Blogger XML-RPC APIを適用できる箇所に対し完全に実装しています。Movable Typeがサポートしないメソッドは、getTemplateとsetTemplateの2つだけです。これは、Movable TypeとBloggerとではテンプレートのシステムが異なるためです。
また、Movable TypeはmetaWeblog XML-RPC APIを適用できる箇所に対しサポートしています。さらにMovable Typeは、エントリーに割り当てたカテゴリーを扱うための独自のメソッドを2つ備えています。
これらのXML-RPC APIを使うときは、ウェブ・サーバーにLWP::UserAgentとSOAP::Liteがインストールされている必要があります。インストールされていない場合は、別節を参照してインストールしてください。
サポートするAPI
サポートしているXML-RPCのメソッドは以下のとおりです。
- blogger.newPost
-
機能 | 新しい投稿を作成し、任意で公開します。 |
パラメーター | String appkey、String blogid、String username、String password、String content、boolean publish |
返り値 | 成功すると新しい投稿のString postid、失敗するとfault |
- blogger.editPost
-
機能 | 既存の投稿についての情報を更新します。 |
パラメーター | String appkey、String postid、String username、String password、String content、boolean publish |
返り値 | 成功するとtrue、失敗するとfault |
- blogger.deletePost
-
機能 | 投稿を削除します。 |
パラメーター | String appkey、String postid、String username、String password、String content、boolean publish |
返り値 | 成功するとtrue、失敗するとfault |
- blogger.getRecentPosts
-
機能 | システムにおける最新の投稿リストを返します。 |
パラメーター | String appkey、String blogid、String username、String password、int numberOfPosts |
返り値 | 成功するとISO.8601 dateCreated、String userid、String postid、String contentを含む構造体の配列、失敗するとfault |
注: | dateCreatedは、ブログのblogidのタイムゾーンに基づきます。 |
- metaWeblog.editPost
-
機能 | 既存の投稿についての情報を更新します。 |
パラメーター | String postid、String username、String password、struct content、boolean publish |
返り値 | 成功するとtrue、失敗するとfault |
注: | 構造体contentには次の標準のキーを含められます: エントリーのタイトルにはtitle、エントリーの本文にはdescription、エントリー作成日の指定にはdateCreated。 さらにMovable Typeの実装によって、次の7つのキーを含め、その値を指定して渡すことができます。 allow_commentsフィールドの値にはint mt_allow_comments、allow_pingsフィールドの値にはint mt_allow_pings、convert_breaksフィールドの値にはString mt_convert_breaks、追記のエントリー・テキストの値にはString mt_text_more、概要のフィールドの値にはString mt_excerpt、キーワード・フィールドの値にはString mt_keywords、このエントリーのトラックバックpingを載せたURLのリストにはarray mt_tb_ping_urls。 dateCreatedを指定する場合は、ISO.8601のフォーマットに従ってください。 |
- metaWeblog.getPost
-
機能 | 特定の投稿についての情報を返します。 |
パラメーター | String postid、String username、String password |
返り値 | 成功すると次を含む構造体:String userid、ISO.8601 dateCreated、String postid、String description、 String title、String link、String permaLink、String mt_excerpt、String mt_text_more、int mt_allow_comments、int mt_allow_pings、String mt_convert_breaks、String mt_keywords、失敗するとfault |
注: | linkとpermaLinkは共にアーカイブされた投稿を指すURLです。 mt_という接頭語で始まるフィールドは、Movable TypeがmetaWeblog.getPost APIを拡張したフィールドです。 |
- metaWeblog.getRecentPosts
-
機能 | システムにおける最新の投稿リストを返します。 |
パラメーター | String blogid、String username、String password、int numberOfPosts |
返り値 | 成功すると次を含む構造体の配列:ISO.8601 dateCreated、String userid、String postid、String description、String title、String link、String permaLink、String mt_excerpt、String mt_text_more、int mt_allow_comments、int mt_allow_pings、String mt_convert_breaks、String mt_keywords、失敗するとfault |
注: | dateCreatedは、ブログのblogidのタイムゾーンに基づきます。また、linkとpermaLinkはアーカイブされた投稿を指すURLです。 |
- metaWeblog.newMediaObject
-
機能 | ウェブ・サーバーにファイルをアップロードします。 |
パラメーター | String blogid、String username、String password、struct file |
返り値 | アップロードしたファイルへのURL |
注: | struct(構造体)fileは次の2つのキーを含んでいます: base64 bits(ファイルのbase64でエンコードされたコンテンツ)およびString name(ファイル名)。 typeキー(ファイルのメディア・タイプ)は現在、無視されています。 |
- mt.getRecentPostTitles
-
機能 | システムにおける最新の投稿を載せた必要最小限のリストを返します。 |
パラメーター | String blogid、String username、String password、int numberOfPosts |
返り値 | 成功すると、ISO.8601 dateCreated、String userid、 String postid、String titleを含む構造体の配列、失敗するとfault |
注: | dateCreatedは、ブログのblogidのタイムゾーンに基づきます。 |
- mt.getCategoryList
-
機能 | ブログに定義された全カテゴリーのリストを返します。 |
パラメーター | String blogid、String username、String password |
返り値 | 成功するとString categoryIdとString categoryNameを含む構造体の配列、失敗するとfault |
- mt.getPostCategories
-
機能 | 投稿されたエントリーに割り当てた全カテゴリーのリストを返します。 |
パラメーター | String postid、String username、String password |
返り値 | 成功するとString categoryName、String categoryId、およびboolean isPrimaryを含む構造体の配列、失敗するとfault |
注: | isPrimaryはカテゴリーがその投稿されたエントリーのメイン・カテゴリーに属すかどうかを表示します。 |
- mt.setPostCategories
-
機能 | 投稿されたエントリーにカテゴリーを指定します。 |
パラメーター | String postid、String username、String password、array categories |
返り値 | 成功するとtrue、失敗するとfault |
注: | array categoriesは、String categoryIdとboolean isPrimary含む構造体の配列です。メイン・カテゴリーを指定するためのisPrimaryはオプションです。このフラグがないと、arrayの最初の構造体が投稿されたエントリーのメイン・カテゴリーに割り当てられます。 |
- mt.supportedMethods
-
機能 | サーバーがサポートするXML-RPCメソッドについての情報を取得します。 |
パラメーター | なし |
返り値 | サーバーがサポートするメソッド名の配列 |
- mt.supportedTextFilters
-
機能 | サーバーがサポートするテキスト・フォーマットのプラグインについての情報を取得します。 |
パラメーター | なし |
返り値 | String keyとString labelを含む構造体の配列。keyはテキスト・フォーマットのプラグインを特定する固有な文字列で、labelはユーザーに表示される説明です。keyはmt_convert_breaksのパラメーターとしてnewPostとeditPostに渡される値です。 |
- mt.getTrackbackPings
-
機能 | 特定のエントリーに投稿されたトラックバックpingのリストを取得します。このメソッドは、特定のエントリーに送られたpingのリストをプログラミングによって取得し、特定のトピックに対し互いに参照し合うエントリー群のウェブグラフを作り上げるまで、リストで得られたpingを次々に反復動作処理するときに使用することもできます。 |
パラメーター | String postid |
返り値 | 次を含む構造体の配列:String pingTitle(pingによって送られたエントリーのタイトル)、String pingURL(エントリーのURL)、およびString pingIP(pingを送ったホストのIPアドレス) |
- mt.publishPost
-
機能 | 1つのエントリーに関連したスタティック・ファイルをすべて、ブログから公開(再構築)します。エントリーをシステムに保存することと同じですが、pingを送信しないところが異なります。 |
パラメーター | String postid、String username、String password |
返り値 | 成功するとtrue、失敗するとfault |
Movable Typeでは、Blogger XML-RPCのメソッドすべてにおいてappkeyの値は無視されます。