アメばた会議API http://ameblo.jp/amebabbs-api/ アメばた会議のAPIについて説明をします。 ja １．はじめに 本ドキュメントは、アメばた会議 掲示板サービス（以下 アメばた と呼称）において提供するAPI機能の仕様について記載するものとなります。

]]> http://ameblo.jp/amebabbs-api/entry-10097315989.html Mon, 10 Mar 2008 18:00:00 +0900 2.1.APIの種類
]]> http://ameblo.jp/amebabbs-api/entry-10097316368.html Mon, 10 Mar 2008 17:50:00 +0900 2.2.APIのプロトコル
RESTについては以下のサイトなどをご参照ください。
http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm

以下、接続例として、
スレッドAPIに対してGETメソッドにてリクエストを送ったケースを例示します。
GET /xml/thread/thread HTTP/1.1
Host: api.amebabbs.ameba.jp


HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Cache-Control: max-age=60
Content-Type: text/xml;charset=UTF-8
Content-Language: ja-JP
Transfer-Encoding: chunked
Date: Fri, 16 May 2008 07:10:54 GMT


<data>
<totalcount>1954</totalcount>
<offset>0</offset>
<length>10</length>
<thread>

</thread>
]]> http://ameblo.jp/amebabbs-api/entry-10097317130.html Mon, 10 Mar 2008 17:40:00 +0900 2.3.API使用時の文字コード API へのリクエストの際に使用する文字コード、ならびにAPI から返却されるデータの文字コード、ともにUTF-8 での送受信を行います。
API リクエストの際に、URI にクエリーストリングとして日本語などダブルバイト文字列を付加したい場合は、UTF-8 の文字列をURL エンコーディングした値を渡すようにしてください。

例：アメばた会議
⇒%E3%82%A2%E3%83%A1%E3%81%B0%E3%81%9F%E4%BC%9A%E8%AD%B0
]]> http://ameblo.jp/amebabbs-api/entry-10097317477.html Mon, 10 Mar 2008 17:30:00 +0900 2.4.APIから返却されるデータのフォーマット RSS形式、XML形式、もしくはJSONP形式になります。
RSSはRSS2.0に準拠しています。
XMLならびにJSONPのデータ項目はアメばた独自のものとなります。
]]> http://ameblo.jp/amebabbs-api/entry-10097321972.html Mon, 10 Mar 2008 17:20:00 +0900 2.5.個人認証について アメばたでは、WSSE認証により、本人性の確認を行います。

WSSE認証では、URIへのリクエストの際に
HTTPのリクエストヘッダ中に「X-WSSE」ヘッダを付与することで
リクエスト元のアイデンティティ情報を送信します。

X-WSSEのフォーマットは以下のようになります。（※改行は含まれません。すべて一行で記載）
X-WSSE: UsernameToken Username="xxxxxxxxxx", PasswordDigest="xxxxxxxxxxxxxxxxxxxxx", Nonce="xxxxxxxxxx", Created="xxxxxxxxxx"
Username：
アメーバID
Nonce：
セキュリティトークン
Created：
セキュリティトークンが作成された日時。フォーマットはW3CDTFに準拠。
例：2008-05-16T07:36:15Z
PasswordDigest：
アメーバIDに対応したパスワードを、MD5によりハッシュ化した値と
nonceの値と
作成日の文字列を連結し
それらの文字列をSHA1によりハッシュ化した値をBase64エンコードした値になります。
以下に、アメばた会議におけるX-WSSEヘッダの生成方法について
擬似コードにて例示します。
String username = amebaId; //アメーバID
String password = md5(plainPassword); //平文のパスワードをMD5アルゴリズムでハッシュ化
String created = created();//セキュリティトークン作成日。フォーマットはW3CDTFに準拠
String noce = nonce();//セキュリティトークン。Base64エンコードされている
String passwordDigest = Base64.encode(sha1(Base64.decode(nonce) . created . password)) ;

String xwsseHeader = "UsernameToken Username=\"" + username + "\" , PasswordDigest=\"" + passwordDigest + "\" ,Nonce=\"" + nonce + "\" ,Created=\"" + created + "\";

request.addHeader("X-WSSE", xwsseHeader);


]]> http://ameblo.jp/amebabbs-api/entry-10097322688.html Mon, 10 Mar 2008 17:10:00 +0900 3.1.返却データフォーマットの確認
以下のように、
各APIのアドレスをブラウザで表示することで、データフォーマットの確認をすることができます。
（下記はスレッドAPI のアドレスになります）

RSS2.0
http://api.amebabbs.ameba.jp/rss/thread/thread
XML
http://api.amebabbs.ameba.jp/xml/thread/thread
JSONP
http://api.amebabbs.ameba.jp/jsonp/thread/thread
]]> http://ameblo.jp/amebabbs-api/entry-10098478128.html Mon, 10 Mar 2008 16:30:00 +0900 3.2.POST/PUT/DELETEの際のデータ送信方法 リソースのデータ更新を行う際は
リクエストボディにXMLのデータを含めて送信をしてください。

例：スレッド作成時
POST /xml/thread/thread HTTP/1.1
X-WSSE: UsernameToken Username="test", PasswordDigest="test", Nonce="test", Created="2008-05-20T07:10:30Z"
Host: api.amebabbs.ameba.jp
Content-Length: 190
Cache-Control: no-cache


<?xml version="1.0"?>
<thread>
<category>1</category>
<showName>test</showName>
<title>test</title>
<showProfileFlg>1</showProfileFlg>
<description>test</description>
</thread>

例：レス投稿時
POST /xml/thread/res/OTo060dn7FEjW-pz583SAv/ HTTP/1.1
Host: dev.amebabbs.ameba.jp
Content-Length: 86
Cache-Control: no-cache


<?xml version="1.0"?>
<comment>
<text>test</text>
<user>test</user>
</comment>
]]> http://ameblo.jp/amebabbs-api/entry-10098499221.html Mon, 10 Mar 2008 16:05:00 +0900 3.3.リクエストに対するHTTPステータスの振る舞い 以下の内容に基づいて返却されます。


APIを使用したアプリケーションでのエラーハンドリングの際にご参考ください。
ステータスコード 意味 振る舞い
200 OK 正常
201 Created 新規リソースが追加された。アメばたではスレッドのPOSTの際のみ返却。
401 Unauthorized 本人性の確認が必要なリソースへのアクセス時にユーザ認証に失敗した場合返却。
403 Forbidden 渡されたリクエスト内容に起因して処理続行不可能なエラーが発生した場合に返却。主に、パラメータのValidationエラーなど。
404 Not Found 指定したリソースが存在しない場合に返却。
405 Method Not Allowed 許可されていないメソッドにてリソースにアクセスした場合に返却。
500 Internal Server Error システム上でエラーが発生した場合に返却。
503 Service Unavailable メンテナンスなどでサービスが一時的に停止している場合に返却。


]]> http://ameblo.jp/amebabbs-api/entry-10098900268.html Mon, 10 Mar 2008 16:00:00 +0900 4.1.スレッドAPI
概要
スレッドの一覧情報の取得、ならびにスレッド作成・変更・削除を行うAPIです

URL
http://api.amebabbs.ameba.jp/rss/thread/thread
http://api.amebabbs.ameba.jp/xml/thread/thread
http://api.amebabbs.ameba.jp/jsonp/thread/thread

JSONPコールバック関数名
thread_thread

許可メソッド
フォーマット GET POST PUT DELETE
RSS ○ － － －
XML ○ ◎ ◎ ◎
JSONP ○ ◎ ◎ ◎

※◎はWSSE認証による本人性の確認が必要な処理です

リクエストパラメータ
項目 GET POST PUT DELETE 必須 備考
offset ○ － － － － データの取得開始位置。0もしくは未指定の場合は最初から。10の場合は10件目からデータを取得
length ○ － － － － データの取得サイズ。デフォルトは10件
range ○ － － － － データの取得範囲。単位は時間。144を指定すると24時間×７＝直近一週間以内に作成されたスレッドを取得する
order
 ○ － － － － データの並び順番。asc-昇順/desc-降順。デフォルトは降順
target
 ○ － － － － データをソートする対象のID。0-作成日順/1-レス更新順/2-レス数順/3-アクセス数順。デフォルトは１（レス更新順）
key
 （○） － ○ ○ ○ スレッド画面のURLに含まれている、スレッドを一意に判断するためのキー文字列。スレッドの更新（PUT）、削除（DELETE）の場合は必須
category
 ○ ○
 ○ － － カテゴリーID。カテゴリーID一覧についてはこちらのページ を参照ください
title
 －
 ○
 ○ － ○ スレッドタイトル
description
 － ○
 ○ － ○ スレッド説明文
showName
 － ○ ○ － ○ スレッド投稿者（スレ主名）として表示する名前
showProfileFlg
 － ○ ○ － ○ アメーバIDを公開する/しないのフラグ。0-非公開/1-公開

レスポンスパラメータ
項目 備考
totalCount 対象となるデータ総件数
offset データ取得開始位置
length データ件数
url スレッドURL
categoryId
 カテゴリーID
amebaId
 投稿者アメーバID。ID非公開にしているユーザの場合、空になる。
threadKey
 スレッドを一意で特定するキー文字列
title
 スレッドタイトル
description
 スレッド説明文
viewCount
 表示回数
resCount
 レス件数
lockFlg
 ロック済みかどうかのフラグ。ロックされているスレッドは閲覧ができない。1-ロック済み
archiveStatus
 未使用
archiveDomain
 未使用
registDatetime
 スレッド作成日時。RFC822形式
editDatetime
 スレッド情報最終更新日時。RFC822形式
lastResDatetime
 レス最終更新日時。RFC822形式。
deleteFlg
 削除フラグ。1-削除済み

]]> http://ameblo.jp/amebabbs-api/entry-10098478621.html Mon, 10 Mar 2008 15:55:00 +0900