小粋空間  -  a cheap joke and a play on words site

Movable Type Data APIの使い方（JavaScript SDKを使ったオブジェクトの生成）

Movable Type 6から提供されるData APIの使い方を紹介します。

本エントリーではJavaScript SDKを使ったオブジェクトの作り方について解説します。

１．jQueryとmt-data-api.js

Data APIを利用するためには、script要素でjQueryとJavaScript SDKに含まれる「mt-data-api.min.js」または「mt-data-api.js」を引き込みます。

<script src="http://user-domain/mt-static/data-api/v1/js/mt-data-api.min.js"></script>

「mt-data-api.min.js」または「mt-data-api.js」はMT6であれば、「/mt-static/data-api/v1/js」配下に置かれているのでこれを利用します。

２．コンストラクタ

Data APIのオブジェクト生成（コンストラクタ）は、次のように「MT.DataAPI」を利用します。

<script>
var api = new MT.DataAPI({
    clientId: 'foo',
    baseUrl:  'http://user-domain/mt-data-api.cgi',
});
</script>

clientID
クライアントIDを設定します。設定可能な値はアルファベットと数字、アンダースコアとハイフンです。clientIDはMTログインユーザ名でなく、任意の文字列で構いません。このIDは認証やcookieを利用する場合に利用されるようです。このオプションは必須です。

baseUrl
DataAPI用CGIのURLを記述します。MT6であればアプリケーションディレクトリ（MTのインストールディレクトリ）直下にあります。このオプションは必須です。

format
返却値のフォーマットを指定します。デフォルトは「json」です。

async
非同期でAPIを動作させたくない場合に「false」を設定します。デフォルトは「true」です。

上記のオプションを指定した場合のサンプルは次のとおりです。

var api = new MT.DataAPI({
    clientId: 'foo',
    baseUrl: 'http://user-domain/mt-data-api.cgi',
    format: 'json',
    async: true,
});

その他にもセッションやキャッシュを利用する場合のオプションが用意されています。詳細は以下のページをご覧ください。

DataAPI SDK english MT.DataAPI Constructor

2013.08.05
オブジェクト生成でjQueryは必要ないので削除しました。