ＡＰＩについて


SuSpooLでは、現在以下のＡＰＩを用意しています。(2009/3/30)

・ステイプルへのカキコミ
・ＡＡ付きカキコミ
・特殊カキコミ
・ユーザーステイプルの取得
・ステイプルスプールの取得
・ユーザースレッドタイトルの取得
・スレッドスプールの取得
・個別スレッドの取得の取得
・ＡＡリストの取得



ステイプルへのカキコミ
カキコミは1000字までの通常カキコミのみ可能で、
直接メールはできません。 ＡＡや画像つき、リンクつきなどのカキコミはpostspecialmessageを 使用します。


アドレス：http://www.suspool.com/ajax?mode=postmessage
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　name　ユーザー名
　ps　パスワード
　message　文面（rawurlencodeが必要）


成功時戻り値
　success post:投稿成功

エラー時の戻り値
　error name or ps：名前かパスワードが一致しない時
　no message：投稿文章が存在しない時
　over message：投稿文章が文字数上限を超えている時
　error post：データベースに保存できなかった時
　IP error:ＩＰが取得できない時



ＡＡ付きカキコミ
1000字までの通常カキコミ情報とＡＡのハッシュＩＤを引数で渡すと
ＡＡつきのカキコミになります。
このとき、文章はＡＡの直下につながって投稿されますが、
ＡＡそのものにdiv要素による自由配置情報がある場合は
その場所にテキストが差し替えられます。
ＡＡのハッシュＩＤはcheckAAlistなどで取得します。
ＩＤのかわりに「random」と記述しておくと、
ランダムなＡＡを自動的に選択して投稿します。
ランダムＡＡは、タイトル名に「■」が入っているものについては 除外して選択するようになっています。
アドレス：http://www.suspool.com/ajax?mode=postAAmessage
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　name　ユーザー名
　ps　パスワード
　aaid　ＡＡのハッシュＩＤ（randomとすると自動的にランダムなＡＡを選択投稿）
　message　文面（rawurlencodeが必要）


成功時戻り値
　success post:投稿成功

エラー時の戻り値
　error name or ps：名前かパスワードが一致しない時
　no message：投稿文章が存在しない時
　over message：投稿文章が文字数上限を超えている時
　error post：データベースに保存できなかった時
　IP error:ＩＰが取得できない時
　error no AA:取得したＡＡのハッシュＩＤが存在しない



特殊カキコミ
リンク・タグ付きのカキコミ、 メモ（投稿せず仮保存する）スレッドへのカキコミ、レスなど
特殊なカキコミ専用ＡＰＩです。 (画像添付カキコミはできません)


アドレス：http://www.suspool.com/ajax?mode=postspecialmessage
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　name　ユーザー名
　ps　パスワード
　type　カキコミタイプ。以下どちらかを指定。未指定の場合は通常カキコミ。
　　linktag　リンクつき、タグつきにする場合
　　memo　投稿せず、一時的に仮保存するメモ機能を使う場合

　message　文面（rawurlencodeが必要）

スレッドにカキコム場合はさらに以下を追加します。
ただしtype属性にmemoが入っている場合は無視されます。
これらのＩＤはcheckthreadtitleＡＰＩを利用することで取得できます。
　id　親ステイプルのユーザーハッシュＩＤ
　num　親ステイプルの番号
　sage　下げカキコにする場合はsage=sageとする。無い場合はage


成功時戻り値
　success post:投稿成功

エラー時の戻り値
　error name or ps：名前かパスワードが一致しない時
　no message：投稿文章が存在しない時
　over message：投稿文章が文字数上限を超えている時
　error post：データベースに保存できなかった時
　IP error:ＩＰが取得できない時
　error not exist thread　該当スレッドが存在しない時



ユーザーステイプルの取得
アドレス：http://www.suspool.com/ajax?mode=checkstaple
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　name　ユーザー名
　ps　パスワード
　offset　オフセット（最新ステイプルを取得する際は無しでも可）


ユーザー名及びパスワードを指定せずにステイプルを取得した場合
ステイプルスプールを返します。
取得できるデータは、タグ形式で表現されています。
タグはエスケープされた形で送信されます。

<STAPLE>
　<USERLINK>ユーザーＵＲＬ</USERLINK>
　<USERICON>ユーザーアイコン</USERICON>
　<LUCKYPOINT>ラッキーポイント</LUCKYPOINT>
　<PARENTLINK>親ステイプルがある場合のフィラメントリンク</PARENTLINK>
　<PARENTICON>親ステイプルがある場合のアイコン画像リンク</PARENTICON>
　<GETBUTTON>取得ボタン数</GETBUTTON>
　<DATE>投稿日時</DATE>
　<MESSAGELINK>該当ステイプルへの直接リンク</MESSAGELINK>
　<MESSAGE>ステイプル本文</MESSAGE>
</STAPLE>

エラー時の戻り値
　error name or ps：名前かパスワードが一致しない時
　no staple：ステイプルが存在しない





ユーザースレッドタイトルの取得
アドレス：http://www.suspool.com/ajax?mode=checkthreadtitle
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　name　ユーザー名
　ps　パスワード
（ユーザー名ないしパスワード情報がない場合はスレッドスプールを取得）
　genre　ジャンル（フォロースレッドを取得する際は無しでも可）
　offset　オフセット（最新スレッドを取得する際は無しでも可）


ジャンルには数値を引数にします。 　　指定なし　フォローしているスレッド
　　genre=1　フォローユーザーの作成したスレッド
　　genre=2　自分の作成したスレッド

ユーザー名及びパスワードを指定せずにスレッドタイトルを取得した場合
スレッドスプールを返します。


<THREAD>
　<THREADLINK>各スレッドＵＲＬ</THREADLINK>
　<THREADICON>スレッドアイコン</THREADICON>
　<FOLLOW>スレッドフォロー人数</FOLLOW>
　<DATE>投稿日時</DATE>
　<THREADTITLE>スレッドタイトル</THREADTITLE>
　<INTRODUCE>スレッド紹介文</INTRODUCE>
</THREAD>


個別スレッドの取得
アドレス：http://www.suspool.com/ajax?mode=checkthread
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　id　スレッドユーザーＩＤ
　num　スレッド番号
　fav　ボタン数抽出（素のままのスレッドデータを取得する際は無しでも可）
　offset　オフセット（最新スレッドを取得する際は無しでも可）



<THREAD>
　　〜ユーザースレッドタイトルの取得と同じ〜
</THREAD>

<STAPLE>
　　〜ユーザーステイプルの取得と同じ〜
</STAPLE>



ＡＡリストの取得
アドレス：http://www.suspool.com/ajax?mode=checkAAlist
文字エンコード：EUC-JP
メソッド：POSTのみ
name属性　value属性：
　name　ユーザー名
　ps　パスワード
　genre　 　offset　オフセット（最新ＡＡを取得する際は無しでも可）

ユーザー名及びパスワード情報がない場合はＡＡスプールを取得します。


<AALIST>
　<AAID>ＡＡの識別ＩＤ</AAID>
　<USERNAME>ＡＡの保管者名</USERNAME>
　<USECOUNT>ＡＡの利用回数</USECOUNT>
　<NEWDATE>最新利用日時</NEWDATE>
　<DATE>投稿日時</DATE>
　<AANAME>ＡＡ名</AANAME>
　<AA>ＡＡ本体</AA>
</AALIST>


エラー時の戻り値
　no AA　該当ＡＡが存在しない場合。


オセリアのＡＰＩ


検討中