全74エンドポイントを一挙紹介。本日発表TypePad JSON APIでブログ・プラットフォーム化へ

こんにちは、ようやく春らしい陽気でエンジンかかってきた TypePad プラットフォーム担当の slash です。

この開発者向けカテゴリーでは今後、TypePad で開発されている最新技術が実現する新しい機能・こころみをご紹介し、またその仕組み (技術情報) について開発者向けサイトをご紹介していきます。(主に新しい機能に興味をお持ちの上級者ユーザの皆様、TypePad に興味をお持ちの開発者の皆様を対象としております。)

さて、先週は TypePad Twitter / Twitpic API に多くの反響を頂きました! 「シックス・アパートも Twitter API か。そうきたか。」と思われた方も多いと思いマス。そんな TypePad Twitter API が、実は「前振り」にも見えてしまうような ブログサービス TypePad としての API。それが本日発表しました TypePad JSON API なんです

シックス・アパートが、ブログ開発者向けAPI「TypePad JSON API」を発表
～新APIの提供により、TypePadをプラットフォームとして利用した多様なアプリケーション開発が可能に～

TypePad JSON APIは、TypePad 内の各種コンテンツに対して、投稿、読み込み、更新、削除など様々なアクセスを実現するための包括的な API です。ポイントを説明しますと、

https://api.typepad.com/ 以下に配置されたREST形式のAPIです。
ユーザー、ブログ、カテゴリ、記事、コメント、画像などの各種コンテンツに対する、投稿、読み込み、更新、削除などの操作を実現する70種類以上のエンドポイントが用意されています。従来のAPIに比べ、TypePad内のデータへより詳細なアクセスが可能になりました。
アクセス認可のためのプロトコルとして OAuth、返信データのフォーマットとしてJSON, JSON-Pをサポートしています。

ということなんです！

また、「TypePadブログへのデータアクセス」という範疇を超え、2009年10月に米国シックス・アパートが発表した「TypePad Motion」のような、TypePadを各種データの保存・共有のためのプラットフォームとして利用する独自のソーシャル・アプリケーションを開発することもできます。

さて今回は、記事タイトルにも書きましたとおり、現在実装されている TypePad JSON APIの主要エンドポイント74を、この下で一気にご紹介！　とても多いのでザックリ眺めて頂いて、だいたいどのようなアクセスができるのかをご理解いただければと思います。ちなみにリンク先のドキュメントページは米シックス・アパートの http://www.typepad.com/services/apidocs 以下ににありますので、適宜ご参照ください。

シックス・アパートでは、今後も TypePad に搭載するAPIの拡充を進め、皆様に TypePad と連携した外部アプリケーションの開発を行っていだけますよう関連情報の公開も整行っていきますので、ぜひよろしくお願いいたします。

※下記の技術情報は TypePad のサポート対象外となります。 TypePad Developers Network については記事の最後をご参照ください。

TypePad JSON API 一覧

APIキー

1./api-keys/<id>: 指定されたAPIキーに関する情報を取得

アプリケーション

2. /applications/<id>: 指定されたアプリケーションに関する情報を取得

Assets

3. /assets: TypePad 全体から、ユーザが作成したコンテンツを検索
4. /assets/<id>: 指定されたアセットに関する情報を取得
5. /assets/<id>/add-category: アセットに対してカテゴリを付与
6. /assets/<id>/categories: アセットに付与されたカテゴリ一覧を取得
7. /assets/<id>/comment-tree: 指定されたアセットに対して投稿された反応の一覧をツリー形式で取得
8. /assets/<id>/comments: 指定されたアセットに対して投稿された反応の一覧を取得
9. /assets/<id>/favorites: 指定されたアセットに対して作成された「お気に入り」の一覧を取得
10. /assets/<id>/feedback-status: 指定されたアセットに対するコメントや反応に関する状態を取得
11. /assets/<id>/make-comment-preview: コメントプレビュー (コメントした場合の結果を取得)
12. /assets/<id>/media-assets: 指定されたアセットの中に埋め込まれたメディア・アセットの一覧を取得
13. /assets/<id>/publication-status: 指定されたアセットの公開状態を取得
14. /assets/<id>/reblogs: 指定されたアセットのリブログとして作られたアセットの一覧を取得
15. /assets/<id>/remove-category: 指定されたアセットからカテゴリを削除

認証トークン

16. /auth-tokens/<id>: 指定された認証トークンに関する情報を取得

バッチ・プロセッサ

17. /batch-processor: 複数のAPIリクエストをバッチジョブとして一括してサーバへ送信し処理を依頼

ブログ

18. /blogs/<id>: 指定されたブログに関する情報を取得
19. /blogs/<id>/add-category: 指定されたブログからのカテゴリを削除
20. /blogs/<id>/categories: 指定されたブログで定義されるカテゴリ一覧を取得
21. /blogs/<id>/commenting-settings: 指定されたブログにおけるコメント関連の設定を取得
22. /blogs/<id>/comments/@published: 指定されたブログにおけるコメント一覧を取得
23. /blogs/<id>/comments/@published/@recent: 指定されたブログにおける最近のコメント一覧を取得
24. /blogs/<id>/crosspost-accounts: 指定されたブログにおいてクロスポストに使用できるアカウント一覧を取得
25. /blogs/<id>/discover-external-post-asset: 指定されたブログが外部ブログの場合、指定された permalink URLに対するスタブを作成
26. /blogs/<id>/media-assets: 指定されたブログに対してメディアアセットを新規投稿
27. /blogs/<id>/page-assets: 指定されたブログに対してWeb ページアセットを新規投稿、またはWebページ一覧を取得
28. /blogs/<id>/post-assets: 指定されたブログに対してブログ記事アセットを新規投稿、またはブログ記事一覧を取得
29. /blogs/<id>/post-assets/@by-category/<id>: 指定されたブログおよびカテゴリ内の記事一覧を取得
30. /blogs/<id>/post-assets/@by-month/<id>: 指定されたブログ内で公開日時が指定された年・月の記事一覧を取得
31. /blogs/<id>/post-assets/@published/@by-category/<id>: 指定されたブログおよびカテゴリ内の公開状態にある記事一覧を取得
32. /blogs/<id>/post-assets/@published/@by-month/<id>: 指定されたブログ内で公開状態にありかつ公開日時が指定された年・月の記事一覧を取得
33. /blogs/<id>/post-assets/@published/@recent: 指定されたブログにおける公開状態の最近50記事の取得
34. /blogs/<id>/post-assets/@recent: 指定されたブログにおける最近50記事の取得 (下書きや予約投稿状態を含む)
35. /blogs/<id>/post-by-email-settings/@by-user/<id>: 指定されたユーザーのメール投稿のための秘密のメールアドレスを取得
36. /blogs/<id>/remove-category: 指定されたブログからのカテゴリを削除
37. /blogs/<id>/stats: 指定されたブログに関するアクセス数のデータを取得

ブラウザ・アップロード

38. /browser-upload: 特定のURLへ multipart/form-data メッセージ形式でファイルを添付してアセットを投稿

Users

39. /users/<id>: 指定されたユーザーに関する情報を取得
40. /users/<id>/blogs: 指定されたユーザーがアクセスできるブログの一覧を取得
41. /users/<id>/elsewhere-accounts: 指定されたユーザーの「他のサービス」一覧を取得
42. /users/<id>/events: 指定されたユーザーに関するアクションが指定されたイベントの一覧を取得
43. /users/<id>/events/@by-group/<id>: 指定されたユーザーに関するアクションが指定された特定のグループにおけるイベントの一覧を取得
44. /users/<id>/favorites: 指定されたユーザーの「お気に入り」一覧を取得
45. /users/<id>/memberships: 指定されたユーザーが保持する、グループとのリレーションシップ一覧を取得
46. /users/<id>/memberships/@admin: 指定されたユーザーが保持する、admin タイプを持った、グループとのリレーションシップ一覧を取得
47. /users/<id>/memberships/@by-group/<id>: 指定されたユーザーが保持する、指定されたグループとのリレーションシップ一覧を取得
48. /users/<id>/memberships/@member: 指定されたユーザーが保持する、member タイプを持った、グループとのリレーションシップ一覧を取得
49. /users/<id>/notifications: 指定されたユーザーが購読中のユーザ達に関するアクションが指定されたイベントの一覧を取得
50. /users/<id>/notifications/@by-group/<id>: 指定されたユーザーを購読中のユーザ達に関するアクションが指定されたイベントの一覧を取得
51. /users/<id>/profile: 指定されたユーザーに関する詳細情報を取得
52. /users/<id>/relationships: 指定されたユーザーが持つ他のユーザーとのリレーションシップ一覧、および他のユーザーが持つ指定されたユーザーとのリレーションシップ一覧を取得
53. /users/<id>/relationships/@by-group/<id>: 指定されたユーザーが持つ他のユーザーとのリレーションシップ一覧、および他のユーザーが持つ指定されたユーザーとのリレーションシップ一覧を取得 (特定グループの参加者に限定)
54. /users/<id>/relationships/@follower: 指定されたユーザーが購読中のユーザー一覧を取得
55. /users/<id>/relationships/@follower/@by-group/<id>: 指定されたユーザーが購読中のユーザー一覧 (特定グループの参加者に限定) を取得
56. /users/<id>/relationships/@following: 指定されたユーザーを購読中のユーザー一覧を取得
57. /users/<id>/relationships/@following/@by-group/<id>: 指定されたユーザーが購読中をユーザー一覧 (特定グループの参加者に限定) を取得

リレーションシップ

58. /relationships/<id>: 指定されたリレーションシップに関する基本情報を取得
59. /relationships/<id>/status: 指定されたリレーションシップに関する、type を含む状態情報を取得

イベント

60. /events/<id>: 指定されたイベントに関する情報を取得

グループ

61. /groups/<id>: 指定されたグループに関する情報を取得
62. /groups/<id>/events: 指定されたグループにおけるイベント一覧を取得
63. /groups/<id>/link-assets: 指定されたグループへリンク・アセットを新規投稿
64. /groups/<id>/memberships: 指定されたグループとユーザー間のリレーションシップ一覧を取得
65. /groups/<id>/memberships/@admin: 指定されたグループとユーザー間の admin タイプを持つリレーションシップ一覧を取得
66. /groups/<id>/memberships/@blocked: 指定されたグループとユーザー間の blocked タイプを持つリレーションシップ一覧を取得
67. /groups/<id>/memberships/@member: 指定されたグループとユーザー間の member タイプを持つリレーションシップ一覧を取得
68. /groups/<id>/photo-assets: 指定されたグループへフォト・アセットを新規投稿
69. /groups/<id>/post-assets: 指定されたグループへ記事・アセットを新規投稿
70. /groups/<id>/video-assets: 指定されたグループへ動画・アセットを新規投稿

Noun

71. /nouns: APIにおけるすべての noun に関する情報を取得
72. /nouns/<id>: 指定された noun に関する情報を取得

オブジェクト・タイプ

73. /object-types: APIにおけるすべてのオブジェクト・タイプに関する情報を取得
74. /object-types/<id>: 指定されたオブジェクト・タイプに関する情報を取得

ドキュメントとリソース

TypePad Twitter API、TypePad Twitpic API の技術情報については、TypePad Developer Resource (http://developer.typepad.com)(米Six Apart提供: 英語)と、そのドキュメンテーションセクションを参照してください。TypePadに興味のある開発者の方は、TypePad Developers Network (米Six Apart主宰: 英語) に参加すると情報交換が行えます。

特記事項

本記事に書かれている技術方法は現在ベータ段階であり、個人向け TypePad のサポート対象外となりますのでご了承ください。TypePad API に関するご質問は、上記 TypePad Developers Network へお願いいたします。