2018年4月22日(日) 17:36 JST

TypePad JSON API 解説を和訳 (和文のみ)

おしらせ

TypePad JSON API
http://everything.typepad.jp/elt/2010/04/typepad-json-api.html
TypePadのJSONベースAPIはTypePad内のコンテンツに対応するインターフェイスをクライアント開発者に提供します。

始める際に¶

    *紹介:APIがどのように構成されているか、どのように使うのかの情報です。
    *認証:TypePad JSON APIをどのように認証するかについて
    *使用制限:APIの使用制限についての情報

APIのエンドポイント¶
以下にTypePad APIでサポートするエンドポイントを紹介する。以下の情報も含む。そのエンドポイントが述べてあるページへのリンク、また、どのHTTPメソッドをサポートし、どのリクエストパラメータを必要とし、どのオブジェクトを返すのか。

APIキー¶
/api-keys/<id>
    選択されたAPIキーがどのアプリケーションに属するかなどの基本情報を取得する。

アプリケーション¶
/applications/<id>
    選択されたアプリケーションについての基本情報を取得する
/applications/<id>/badges
    このアプリケーションで定義されたバッジのリストを取得する
/applications/<id>/create-external-feed-subscription
    ひとつ以上の外部RSSフィードのアプリケーションを購読する
/applications/<id>/external-feed-subscriptions
    有効な外部RSS購読アプリケーションのリストを取得する
/applications/<id>/groups
    このアプリケーションのapp_fullアクセス認証トークン使用中のユーザーグループのリストを取得する

情報¶

/assets
    TypePad全体のユーザー作成コンテンツを検索する
/assets/<id>
    選択した情報に関する基本的な情報を取得する
/assets/<id>/add-category
    情報にカテゴリを追加するラベル引数を送信する
/assets/<id>/categories
    ブログの中でその情報が置かれたカテゴリのリストを取得。現在はひとつのブログの中でのPOST情報のみをサポート。
/assets/<id>/comment-tree
    選択された情報に対してpostされた別の情報とそのレスポンスツリーにおける深さのリストを取得
/assets/<id>/comments
    選択された情報に対してpostされた情報のリストを取得
/assets/<id>/extended-content
    ある情報の拡張コンテンツを取得。現在はあるブログ内でpostされたpost情報のみをサポートしている。
/assets/<id>/favorites
    選択された情報に対して生成されたお気に入りのリストを取得
/assets/<id>/feedback-status
    選択された情報に対するfeedbackの状況を取得
/assets/<id>/make-comment-preview
    投稿されたコメントがどのように見えるか、その形の関連データを送信
/assets/<id>/media-assets
    選択された情報コンテンツに埋め込まれたメディア情報のリストを取得
/assets/<id>/publication-status
    選択された情報の公開状況を取得
/assets/<id>/reblogs
    選択された情報がリブログされたpostのリストを取得
/assets/<id>/remove-category
    ある情報がカテゴリから外されたラベル引数を送信
/assets/<id>/update-publication-status
    ある情報の公開状況を調整

認証トークン¶

/auth-tokens/<id>
    選択された認証トークンがどのオブジェクトへのアクセスを許可されたのか他の基本的な情報を取得。
    
バッジ¶
/badges/<id>
    選択されたバッジの基本的な情報を取得

バッチプロセッサ¶
/batch-processor
    バッチジョブとして実行されることを選択されたAPIリクエストを送信

ブログ¶
/blogs/<id>
    選択されたブログについての基本的な情報を取得
/blogs/<id>/add-category
    ブログから削除するカテゴリのラベル引数を送信
    (訳者注:add-categoryなので追加するカテゴリと思われるが説明文にはremove=削除とある。書き間違えの可能性)
/blogs/<id>/categories
    選択されたブログに定義されたカテゴリのリストを取得
/blogs/<id>/commenting-settings
    このブログのコメント関連の設定を取得
/blogs/<id>/comments/@published
    選択されたブログの公開済みのコメントのHTML化されたリストを返す
/blogs/<id>/comments/@published/@recent
    選択されたブログの最新50個の公開済みコメントを返す
/blogs/<id>/crosspost-accounts
    このブログにクロスポスト出来るアカウントのリストを取得
/blogs/<id>/discover-external-post-asset
    参照;http://www.movabletype.jp/documentation/typepadconnect/connect_a_blog_mt.html
    選択されたブログが登録されたブログの場合、そのパーマリンクに対する外部postスタブを生成または拾い出す
/blogs/<id>/media-assets
    このブログを所有するアカウントに新たなメディア情報を追加する
/blogs/<id>/page-assets
    選択されたブログ内にあるページのリストを取得
/blogs/<id>/post-assets
    選択されたブログ内にある投稿のリストを取得
/blogs/<id>/post-assets/@by-category/<id>
    選択されたブログで所与のカテゴリに所属する閲覧可能な全ての投稿を取得
/blogs/<id>/post-assets/@by-month/<id>
    選択されたブログの全ての閲覧可能な投稿のうち特定の月のものを取得。"YYYY-MM"の文字列で指定。
/blogs/<id>/post-assets/@published/@by-category/<id>
    選択されたブログの中で所与のカテゴリに割り当てられた公開済み投稿を取得
/blogs/<id>/post-assets/@published/@by-month/<id>
    選択されたブログから特定の月の公開済み投稿を取得
/blogs/<id>/post-assets/@published/@recent
    選択されたブログから最新50の公開済み投稿を取得
/blogs/<id>/post-assets/@recent
    選択されたブログの最新50の投稿(ドラフト投稿と予約投稿含む)を取得。
/blogs/<id>/post-by-email-settings/@by-user/<id>
    選択されたユーザーのメール投稿アドレスを取得
/blogs/<id>/remove-category
    ブログから削除するカテゴリのラベル引数を送信
/blogs/<id>/stats
    選択されたブログのページビューに関するデータを取得

ブラウザアップロード¶
/browser-upload
    特定のURLにmultipart/form-data形式でファイルを添付して情報を投稿する

クライアント・ライブラリ・ヘルパー¶
/client-library-helpers/<id>
    クライアント・ライブラリでのコード生成に使うための幾つかのデータを抽出。

イベント¶
/events/<id>
    選択されたイベントに関する基本的な情報をを取得

外部フィードの購読¶
/external-feed-subscriptions/<id>
    選択された購読に関する基本的な情報を取得
/external-feed-subscriptions/<id>/add-feeds
    購読に1つ以上のIDを付与する
/external-feed-subscriptions/<id>/feeds
    購読されているフィードのIDを含む文字列を取得。
/external-feed-subscriptions/<id>/remove-feeds
    購読対象から1つ以上のフィードIDを削除
/external-feed-subscriptions/<id>/update-filters
    購読フィードのフィルタリング・ルールを変更する
/external-feed-subscriptions/<id>/update-notification-settings
    コールバックURLの変更、または同時に購読フィードの秘密
    (secretはselectの誤記の可能性。→コールバックURLの変更、または同時に購読フィードの変更)
/external-feed-subscriptions/<id>/update-user
    管理者の承認なしで記事を公開するユーザーをグループが所有するフィード購読に変更する


お気に入り¶
/favorites/<id>
    選択されたお気に入りに関する基本的な情報、所有者とその対象情報などを取得。

グループ¶
/groups/<id>
    選択されたグループに関する基本的な情報をを取得
/groups/<id>/add-member
    そのユーザーを選択されたグループのメンバーにする
/groups/<id>/audio-assets
    選択されたグループ内に新しくオーディオ情報を生成する
/groups/<id>/block-user
    あるユーザーが特定のグループに入れないようにする。そのユーザーを除外する。
/groups/<id>/create-external-feed-subscription
    1つ以上の外部フィードにグループを購読させる。
/groups/<id>/events
    選択されたグループ内に記述されているイベントのリストを取得
/groups/<id>/external-feed-subscriptions
    そのグループの有効な外部購読フィードのリストを取得
/groups/<id>/link-assets
    選択されたグループ内にリンク情報を新たに生成する
/groups/<id>/memberships
    選択されたグループとユーザー間の関係のリストを取得
/groups/<id>/memberships/@admin
    選択されたグループとユーザー間のadminタイプの関係のリストを取得
/groups/<id>/memberships/@blocked
    選択されたグループとユーザー間のブロックされた(blocked type)関係のリストを取得(グループ    admin限定)    
/groups/<id>/memberships/@member
    選択されたグループとユーザー間のメンバータイプの関係のリストを取得
/groups/<id>/photo-assets
    選択されたグループ内に写真情報を新たに生成する
/groups/<id>/post-assets
    選択されたグループ内に投稿情報を新たに生成する
/groups/<id>/remove-member
    あるユーザーを選択されたグループのメンバーから除外する
/groups/<id>/unblock-user
    選択されたグループへの加入をブロックされていたメンバーを、その対象から除外する(メンバー加入できるようにする)
/groups/<id>/video-assets
    選択されたグループ内にビデオ情報を新たに生成する

Nouns ¶
/nouns
    API内の全てのnounに関する情報を取得。そのサブリソースとフィルターも取得。
/nouns/<id>
    選択されたnounとそのサブリソースとフィルターに関する情報を取得。

オブジェクトタイプ¶
/object-types
    API内の全てのオブジェクトタイプに関する情報、プロパティの名前やタイプなどを取得
/object-types/<id>
    選択されたオブジェクトのタイプとプロパティに関する情報を取得

関係性¶
/relationships/<id>
    選択された関係に関する基本的な情報を取得
/relationships/<id>/status
    選択された関係の状況情報、そのタイプなどを取得。

ユーザー¶
/users/<id>
    選択されたユーザーに関する基本的な情報を取得
/users/<id>/badges
    選択されたユーザーが保有するバッジのリストを取得
/users/<id>/blogs
    選択されたユーザーがアクセスしたブログのリストを取得
/users/<id>/elsewhere-accounts
    選択されたユーザーの「他のサービス」一覧を取得
/users/<id>/events
    選択されたユーザーが行ったイベントのリストを取得
/users/<id>/events/@by-group/<id>
    特定のグループのユーザーが行ったイベントのリストを取得
/users/<id>/favorites
    選択されたユーザーのお気に入りのリストを取得
/users/<id>/memberships
    選択されたユーザーと各グループとの関係のリストを取得
/users/<id>/memberships/@admin
    選択されたユーザーと各グループとのadminタイプの関係のリストを取得
/users/<id>/memberships/@by-group/<id>
    選択されたユーザーと特定のループとの間の関係のみのリストを取得、そのグループとの関係が無い場合は空のリストを取得。
/users/<id>/memberships/@member
    選択されたユーザーと各グループとのmemberタイプの関係のリストを取得
/users/<id>/notifications
    選択されたユーザーがフォローしているユーザーによるイベントのリストを取得
/users/<id>/notifications/@by-group/<id>
    選択されたユーザーがフォローしているユーザーが所属する特定のグループのイベントのリストを取得
/users/<id>/profile
    ユーザーのプロフィールページのための詳細なプロパティの取得
/users/<id>/relationships
    選択されたユーザーと他のユーザーとの関係、他のユーザーとそのユーザーとの関係リストを取得。
/users/<id>/relationships/@by-group/<id>
    選択されたユーザーと他のユーザーとの関係、他のユーザーとそのユーザーとの関係で、特定のグループのメンバーに強制されているもののリストを取得。
/users/<id>/relationships/@by-user/<id>
    選択されたユーザーと他の特定の一人のユーザーとの関係のリストを取得
/users/<id>/relationships/@follower
    選択されたユーザーが他のユーザーと持っている関係でcontactタイプのもののリストを取得
/users/<id>/relationships/@follower/@by-group/<id>
    選択されたユーザーが他のユーザーと持っている関係でcontactタイプのもののリストで特定のグループに矯正されているもののリストを取得。
/users/<id>/relationships/@following
    他のユーザーが選択されたユーザーと持っている関係でcontactタイプのもののリストを取得
/users/<id>/relationships/@following/@by-group/<id>
    他のユーザーが選択されたユーザーと持っている関係でcontactタイプのもので、特定のグループのメンバーにするに強制されているもののリストを取得。

オブジェクトタイプ¶
次に示すのはTypePad APIで使われるオブジェクトのリファレンスです。開発者の方はアプリケーション開発においてこれらをclassに置き換えて使うことになる筈です。

クライアントライブラリーでは、ここに定義されているプロパティ名を使うことを推奨します。各国語で使う場合に少々の調整が必要かもしれません。そのためにもこのドキュメントを活用ください。

    * Account
    * ApiKey
    * Application
    * Asset
    * AssetExtendedContent
    * AssetRef
    * AssetSource
    * Audio
    * AudioLink
    * AuthToken
    * Badge
    * Base
    * Blog
    * BlogCommentingSettings
    * BlogStats
    * Comment
    * CommentTreeItem
    * ContainerRef
    * Endpoint
    * Entity
    * Event
    * ExternalFeedSubscription
    * Favorite
    * FeedbackStatus
    * Group
    * ImageLink
    * Link
    * ObjectProperty
    * ObjectType
    * Page
    * Photo
    * Post
    * PostByEmailAddress
    * PublicationStatus
    * Relationship
    * RelationshipStatus
    * User
    * UserBadge
    * UserProfile
    * Video
    * VideoLink

追加情報¶
    *バッチプロセス:一回のリクエストで複数のAPIを動作させること
    *ブラウザでのファイルアップロード:ブラウザからウェブアプリケーションでファイルを直接TypePadにアップロードすること