| <h1 id="nh1">開発者向け Ask Mona API</h1> | <h1 id="nh1">開発者向け Ask Mona API</h1> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>Ask Monaでは以下の通りAPIを用意しています。適切なパラメータを指定してリクエストすると、結果をJSON形式で返します。</p> | <p>Ask Monaでは以下の通りAPIを用意しています。適切なパラメータを指定してリクエストすると、結果をJSON形式で返します。</p> | ||
| <p>APIにつきまして、ご不明な点またはご要望等ございましたら、お気軽に<a href="mailto:askmona.org@gmail.com">メール</a>または<a href="http://askmona.org/1045">Ask Mona APIトピック</a>までご連絡いただければと思います。</p> | |||
| <h3 style="font-size:100%;margin:0 0 -15px 0;">公開API</h3> | <h3 style="font-size:100%;margin:0 0 -15px 0;">公開API</h3> | ||
| <ul> | <ul> | ||
| <li><a href="#topics_list">トピック取得API</a></li> | <li><a href="#topics_list">トピック取得API</a></li> | ||
| <li><a href="#responses_list">レス取得API</a></li> | <li><a href="#responses_list">レス取得API</a></li> | ||
| <li><a href="#users_profile">プロフィール取得API</a></li> | <li><a href="#users_profile">プロフィール取得API</a></li> | ||
| </ul> | </ul> | ||
| <h3 style="font-size:100%;margin:0 0 -15px 0;">要認証API</h3> | <h3 style="font-size:100%;margin:0 0 -15px 0;">要認証API</h3> | ||
| <ul> | <ul> | ||
| <li><a href="#topics_new">新規トピックAPI</a></li> | |||
| <li><a href="#topics_edit">トピック編集API</a></li> | |||
| <li><a href="#responses_post">レス投稿API</a></li> | <li><a href="#responses_post">レス投稿API</a></li> | ||
| <li><a href="#users_myprofile">プロフィール変更API</a></li> | <li><a href="#users_myprofile">マイプロフィールAPI</a></li> | ||
| <li><a href="#favorites_list">お気に入り取得API</a></li> | <li><a href="#favorites_list">お気に入り取得API</a></li> | ||
| <li><a href="#favorites_add">お気に入り追加API</a></li> | <li><a href="#favorites_add">お気に入り追加API</a></li> | ||
| <li><a href="#favorites_delete">お気に入り削除API</a></li> | <li><a href="#favorites_delete">お気に入り削除API</a></li> | ||
| <li><a href="#account_deposit">MONA入金アドレス取得API</a></li> | <li><a href="#account_deposit">MONA入金アドレス取得API</a></li> | ||
| <li><a href="#account_withdraw">MONA出金依頼API</a></li> | <li><a href="#account_withdraw">MONA出金依頼API</a></li> | ||
| <li><a href="#account_send">MONA送金API</a></li> | <li><a href="#account_send">MONA送金API</a></li> | ||
| <li><a href="#account_balance">残高取得API</a></li> | <li><a href="#account_balance">残高取得API</a></li> | ||
| <li><a href="#account_txdetail">取引明細取得API</a></li> | <li><a href="#account_txdetail">取引明細取得API</a></li> | ||
| <li><a href="#auth_verify">シークレットキー検証API</a></li> | <li><a href="#auth_verify">シークレットキー検証API</a></li> | ||
| </ul> | </ul> | ||
| <h3 style="font-size:100%;margin:0 0 -15px 0;">要パスワードAPI</h3> | <h3 style="font-size:100%;margin:0 0 -15px 0;">要パスワードAPI</h3> | ||
| <ul> | <ul> | ||
| <li><a href="#auth_signup">Ask Mona登録API</a></li> | <li><a href="#auth_signup">Ask Mona登録API</a></li> | ||
| <li><a href="#auth_secretkey">シークレットキー取得API</a></li> | <li><a href="#auth_secretkey">シークレットキー取得API</a></li> | ||
| </ul> | </ul> | ||
| <p>要認証API・要パスワードAPIを利用するには、アプリケーション登録が必要です。登録は、<a href="/developers/mypage" rel="nofollow">開発者マイページ</a>から行えます（ログインが必要です）。登録後は、下記のチャート（１）または（２）のどちらかに従って利用してください。</p> | <p>要認証API・要パスワードAPIを利用するには、アプリケーション登録が必要です。登録は、<a href="/developers/mypage" rel="nofollow">開発者マイページ</a>から行えます（ログインが必要です）。登録後は、下記のチャート（１）または（２）のどちらかに従って利用してください。</p> | ||
| <h3 style="font-size:100%;margin:0 0 -15px 0;">要認証API 利用チャート（１） 主にネイティブアプリ向け</h3> | <h3 style="font-size:100%;margin:0 0 -15px 0;">要認証API 利用チャート（１） 主にネイティブアプリ向け</h3> | ||
| <ol> | <ol> | ||
| <li>開発者が<a href="/developers/mypage" rel="nofollow">開発者マイページ</a>からアプリケーション登録をする。</li> | <li>開発者が<a href="/developers/mypage" rel="nofollow">開発者マイページ</a>からアプリケーション登録をする。</li> | ||
| <li>シークレットキー取得APIを使って、認証キーの作成に使うシークレットキーを取得してAPIを利用。</li> | <li>シークレットキー取得APIを使って、認証キーの作成に使うシークレットキーを取得してAPIを利用。</li> | ||
| </ol> | </ol> | ||
| <h3 style="font-size:100%;margin:0 0 -15px 0;">要認証API 利用チャート（２） 主にウェブアプリ向け</h3> | <h3 style="font-size:100%;margin:0 0 -15px 0;">要認証API 利用チャート（２） 主にウェブアプリ向け</h3> | ||
| <ol> | <ol> | ||
| <li>開発者が<a href="/developers/mypage" rel="nofollow">開発者マイページ</a>からアプリケーション登録をする。</li> | <li>開発者が<a href="/developers/mypage" rel="nofollow">開発者マイページ</a>からアプリケーション登録をする。</li> | ||
| <li>利用者に、ログインした状態で、アプリ連携ページ（http://askmona.org/auth/?app_id=[アプリケーションID]）にアクセスしてもらう。</li> | <li>利用者に、ログインした状態で、アプリ連携ページ（http://askmona.org/auth/?app_id=[アプリケーションID]）にアクセスしてもらう。</li> | ||
| <li>利用者に対して、認証コード（JSON形式で{"u_id":***,"secretkey":"***"}という形をとる）が表示される。</li> | <li>利用者に対して、認証コード（JSON形式で{"u_id":***,"secretkey":"***"}という形をとる）が表示される。</li> | ||
| <li>利用者がAsk Monaから認証先URLのページに移動し、アプリケーションに認証コードを入力する。</li> | <li>利用者がAsk Monaから認証先URLのページに移動し、アプリケーションに認証コードを入力する。</li> | ||
| <li>開発者が認証コードから、利用者のユーザーIDと認証キーの作成に使うシークレットキーを取得する。</li> | <li>開発者が認証コードから、利用者のユーザーIDと認証キーの作成に使うシークレットキーを取得する。</li> | ||
| <li><a href="#auth_verify">シークレットキー検証API</a>で検証を行い、APIを利用。</li> | <li><a href="#auth_verify">シークレットキー検証API</a>で検証を行い、APIを利用。</li> | ||
| </ol> | </ol> | ||
| <p>現在、１つのアカウントで作成できるアプリケーションは、１つまでとなっています。複数アプリケーションを作成される方は、新たにアカウントを取得してください。</p> | <p>現在、１つのアカウントで作成できるアプリケーションは、１つまでとなっています。複数アプリケーションを作成される方は、新たにアカウントを取得してください。</p> | ||
| <p>シークレットキーの長さは、現在45字となっています。シークレットキーは、各アプリケーション・各ユーザーごとに異なっています。</p> | <p>シークレットキーの長さは、現在45字となっています。シークレットキーは、各アプリケーション・各ユーザーごとに異なっています。</p> | ||
| <h3 style="font-size:100%;margin:0 0 -15px 0;">APIエンドポイント</h3> | <h3 style="font-size:100%;margin:0 0 -15px 0;">APIエンドポイント</h3> | ||
| <ul> | <ul> | ||
| <li>http://askmona.org/v1/</li> | <li>http://askmona.org/v1/</li> | ||
| <li>https://askmona.org/v1/ （一部の公衆無線LAN等、ネットワークが信頼できない場合はこちらもご利用いただけます。）</li> | <li>https://askmona.org/v1/ （一部の公衆無線LAN等、ネットワークが信頼できない場合はこちらもご利用いただけます。）</li> | ||
| </ul> | </ul> | ||
| </div> | </div> | ||
| <h2 id="topics_list">トピック取得API</h2> | <h2 id="topics_list">トピック取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、トピックの一覧を取得することができます。</p> | <p>このAPIを使うと、トピックの一覧を取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>GET http://askmona.org/v1/topics/list</p> | <p>GET http://askmona.org/v1/topics/list</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>cat_id (optional)</td><td>トピックの<a href="#cat_id">カテゴリID</a>。0を指定した場合は無視されます。</td></tr> | <tr><td>cat_id (optional)</td><td>トピックの<a href="#cat_id">カテゴリID</a>。0を指定した場合は無視されます。</td></tr> | ||
| <tr><td>tag (optional)</td><td>トピックにつけられたタグ。</td></tr> | <tr><td>tag (optional)</td><td>トピックにつけられたタグ。</td></tr> | ||
| <tr><td>safe (default = 0)</td><td>セーフモード。1は有効、0は無効を意味します。セーフモードを有効にしたときはR18カテゴリのトピックは返されません。</td></tr> | |||
| <tr><td>order (default = 'updated')</td><td>並べ替える条件。'updated'は更新順、'created'は作成順、'favorites'はお気に入り順、'receive'はやり取りされたMONA順で並べ替えられます。</td></tr> | <tr><td>order (default = 'updated')</td><td>並べ替える条件。'updated'は更新順、'created'は作成順、'favorites'はお気に入り順、'receive'はやり取りされたMONA順で並べ替えられます。</td></tr> | ||
| <tr><td>limit (default = 25)</td><td>取得するトピックの個数。最大値は1000です。</td></tr> | <tr><td>limit (default = 25)</td><td>取得するトピックの個数。最大値は1000です。</td></tr> | ||
| <tr><td>offset (default = 0)</td><td>取得するトピックのオフセット（取得開始位置）。最大値は9000です。</td></tr> | <tr><td>offset (default = 0)</td><td>取得するトピックのオフセット（取得開始位置）。最大値は9000です。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>count (integer)</td><td>検索条件に一致するトピックの総数。タグやカテゴリを条件とした場合は、1000件を超えるトピックがあっても1000が返されます。</td></tr> | |||
| <tr><td>topics (list)</td><td><a href="#topic_object">トピックオブジェクト</a>のリスト。</td></tr> | <tr><td>topics (list)</td><td><a href="#topic_object">トピックオブジェクト</a>のリスト。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="topic_object">トピックオブジェクトについて</h2> | <h2 id="topic_object">トピックオブジェクトについて</h2> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>rank (integer)</td><td>トピックの順位。トピックオブジェクトをリスト形式で取得したときのみ返されます。</td></tr> | <tr><td>rank (integer)</td><td>トピックの順位。トピックオブジェクトをリスト形式で取得したときのみ返されます。</td></tr> | ||
| <tr><td>t_id (integer)</td><td>トピックID。</td></tr> | <tr><td>t_id (integer)</td><td>トピックID。</td></tr> | ||
| <tr><td>state (integer)</td><td><a href="#topic_state">トピックの状態</a>。ビットフラグで返されます。</td></tr> | |||
| <tr><td>title (string)</td><td>トピックのタイトル。</td></tr> | <tr><td>title (string)</td><td>トピックのタイトル。</td></tr> | ||
| <tr><td>cat_id (integer)</td><td>トピックの<a href="#cat_id">カテゴリID</a>。</td></tr> | <tr><td>cat_id (integer)</td><td>トピックの<a href="#cat_id">カテゴリID</a>。</td></tr> | ||
| <tr><td>category (string)</td><td>トピックのカテゴリ。</td></tr> | <tr><td>category (string)</td><td>トピックのカテゴリ。</td></tr> | ||
| <tr><td>tags (string; nullable)</td><td>トピックにつけられたタグ。</td></tr> | <tr><td>tags (string; nullable)</td><td>トピックにつけられたタグ。</td></tr> | ||
| <tr><td>lead (string)</td><td>トピック本文のリード。</td></tr> | <tr><td>lead (string)</td><td>トピック本文のリード。</td></tr> | ||
| <tr><td>created (integer)</td><td>作成された時刻（UNIX時刻）。</td></tr> | <tr><td>created (integer)</td><td>作成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>updated (integer)</td><td>最後にトピックが浮上した時刻（UNIX時刻）。</td></tr> | <tr><td>updated (integer)</td><td>最後にトピックが浮上した時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>modified (integer)</td><td>更新された時刻（UNIX時刻）。</td></tr> | <tr><td>modified (integer)</td><td>更新された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>count (integer)</td><td>レスの数。</td></tr> | <tr><td>count (integer)</td><td>レスの数。</td></tr> | ||
| <tr><td>receive (string)</td><td>やり取りされたMONA（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | <tr><td>receive (string)</td><td>やり取りされたMONA（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | ||
| <tr><td>favorites (integer)</td><td>お気に入り登録者数。</td></tr> | <tr><td>favorites (integer)</td><td>お気に入り登録者数。</td></tr> | ||
| <tr><td>editable (integer)</td><td>第三者によるトピックの編集が可能かどうか。1は可能。0は禁止を意味します。</td></tr> | |||
| <tr><td>sh_host (integer)</td><td>投稿した人のホスト情報を表示するかどうか。0は非表示。1はID表示。2はID＋プロバイダ名表示を意味します。</td></tr> | |||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>added (integer)</td><td>お気に入りに追加された時刻（UNIX時刻）。お気に入り取得API固有のプロパティです。</td></tr> | <tr><td>added (integer)</td><td>お気に入りに追加された時刻（UNIX時刻）。お気に入り取得API固有のプロパティです。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="topic_state">トピックの状態について</h2> | |||
| <table class="api"> | |||
| <tr><th class="api_p">値</th><th class="api_d">状態</th></tr> | |||
| <tr><td>1</td><td>トピックの表示が可能</td></tr> | |||
| <tr><td>2</td><td>各レスに対する送金が可能</td></tr> | |||
| <tr><td>4</td><td>トピックの編集が可能</td></tr> | |||
| <tr><td>8</td><td>トピックに書き込みが可能（1000レスを超えるトピックには、このフラグが真でも書き込めません）</td></tr> | |||
| <tr><td>16</td><td>予備</td></tr> | |||
| <tr><td>32</td><td>予備</td></tr> | |||
| <tr><td>64</td><td>予備</td></tr> | |||
| <tr><td>128</td><td>予備</td></tr> | |||
| </table> | |||
| <h2 id="cat_id">カテゴリIDについて</h2> | <h2 id="cat_id">カテゴリIDについて</h2> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">cat_id</th><th class="api_d">カテゴリ</th></tr> | <tr><th class="api_p">cat_id</th><th class="api_d">カテゴリ</th></tr> | ||
| <tr><td>0</td><td>その他</td></tr> | <tr><td>0</td><td>その他</td></tr> | ||
| <tr><td>1</td><td>ばらまき</td></tr> | <tr><td>1</td><td>ばらまき</td></tr> | ||
| <tr><td>2</td><td>初心者</td></tr> | <tr><td>2</td><td>初心者</td></tr> | ||
| <tr><td>3</td><td>ニュース</td></tr> | <tr><td>3</td><td>ニュース</td></tr> | ||
| <tr><td>4</td><td>議論・討論</td></tr> | <tr><td>4</td><td>議論・討論</td></tr> | ||
| <tr><td>5</td><td>趣味・生活</td></tr> | <tr><td>5</td><td>趣味・生活</td></tr> | ||
| <tr><td>6</td><td>創作・文化</td></tr> | <tr><td>6</td><td>創作・文化</td></tr> | ||
| <tr><td>7</td><td>ネタ・雑談</td></tr> | <tr><td>7</td><td>ネタ・雑談</td></tr> | ||
| <tr><td>8</td><td>経済・社会</td></tr> | <tr><td>8</td><td>経済・社会</td></tr> | ||
| <tr><td>9</td><td>科学・IT</td></tr> | <tr><td>9</td><td>科学・IT</td></tr> | ||
| <tr><td>10</td><td>採掘</td></tr> | <tr><td>10</td><td>採掘</td></tr> | ||
| <tr><td>11</td><td>R18</td></tr> | <tr><td>11</td><td>R18</td></tr> | ||
| </table> | </table> | ||
| <h2 id="responses_list">レス取得API</h2> | <h2 id="responses_list">レス取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、特定のトピックのレスを取得することができます。</p> | <p>このAPIを使うと、特定のトピックのレスを取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>GET http://askmona.org/v1/responses/list</p> | <p>GET http://askmona.org/v1/responses/list</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>t_id (required)</td><td>トピックID。</td></tr> | <tr><td>t_id (required)</td><td>トピックID。</td></tr> | ||
| <tr><td>from (default = 1)</td><td>取得するレス番号の開始位置。最小値は1です。</td></tr> | <tr><td>from (default = 1)</td><td>取得するレス番号の開始位置。最小値は1です。</td></tr> | ||
| <tr><td>to (default = from)</td><td>取得するレス番号の終了位置。最大値は1000です。指定しなかった場合は、fromで指定した１つのレスのみを返します。</td></tr> | <tr><td>to (default = from)</td><td>取得するレス番号の終了位置。最大値は1000です。指定しなかった場合は、fromで指定した１つのレスのみを返します。</td></tr> | ||
| <tr><td>topic_detail (default = 0)</td><td>トピック情報を取得すかどうか。0を指定した場合取得しません。1を指定した場合、トピック情報を取得します。</td></tr> | <tr><td>topic_detail (default = 0)</td><td>トピック情報を取得すかどうか。0を指定した場合取得しません。1を指定した場合、トピック情報を取得します。</td></tr> | ||
| <tr><td>if_updated_since (default = 0)</td><td>非推奨</td></tr> | <tr><td>if_updated_since (default = 0)</td><td>非推奨</td></tr> | ||
| <tr><td>if_modified_since (default = 0)</td><td>前回の問い合わせ時の更新時刻（UNIX時刻）を指定してください。更新がなければ、statusに2を返して、内容は返しません。負荷低減にご協力をお願いします。</td></tr> | <tr><td>if_modified_since (default = 0)</td><td>前回の問い合わせ時の更新時刻（UNIX時刻）を指定してください。更新がなければ、statusに2を返して、内容は返しません。負荷低減にご協力をお願いします。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗、2は更新なしを意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗、2は更新なしを意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>updated (integer)</td><td>非推奨：最後にトピックが浮上した時刻（UNIX時刻）。</td></tr> | <tr><td>updated (integer)</td><td>非推奨：最後にトピックが浮上した時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>modified (integer)</td><td>更新された時刻（UNIX時刻）。</td></tr> | <tr><td>modified (integer)</td><td>更新された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>topic (object)</td><td><a href="#topic_object">トピックオブジェクト</a>。topic_detailに1を指定した場合のみ返却されます。</td></tr> | <tr><td>topic (object)</td><td><a href="#topic_object">トピックオブジェクト</a>。topic_detailに1を指定した場合のみ返却されます。</td></tr> | ||
| <tr><td>responses (list)</td><td><a href="#response_object">レスポンスオブジェクト</a>のリスト。</td></tr> | <tr><td>responses (list)</td><td><a href="#response_object">レスポンスオブジェクト</a>のリスト。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="response_object">レスポンスオブジェクトについて</h2> | <h2 id="response_object">レスポンスオブジェクトについて</h2> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>r_id (integer)</td><td>レス番号。</td></tr> | <tr><td>r_id (integer)</td><td>レス番号。</td></tr> | ||
| <tr><td>state (integer)</td><td><a href="#response_state">レスの状態</a>。ビットフラグで返されます。</td></tr> | |||
| <tr><td>created (integer)</td><td>投稿された時刻（UNIX時刻）。</td></tr> | <tr><td>created (integer)</td><td>投稿された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>u_id (integer)</td><td>投稿した人のユーザーID。</td></tr> | <tr><td>u_id (integer)</td><td>投稿した人のユーザーID。</td></tr> | ||
| <tr><td>u_name (string)</td><td>投稿した人の名前。</td></tr> | <tr><td>u_name (string)</td><td>投稿した人の名前。</td></tr> | ||
| <tr><td>u_dan (string)</td><td>投稿した人の段位。</td></tr> | <tr><td>u_dan (string)</td><td>投稿した人の段位。</td></tr> | ||
| <tr><td>u_times (string)</td><td>投稿した人の投稿回数について情報。たとえば、５回中３回目の投稿の場合、文字列「3/5」で返されます。</td></tr> | <tr><td>u_times (string)</td><td>投稿した人の投稿回数について情報。たとえば、５回中３回目の投稿の場合、文字列「3/5」で返されます。</td></tr> | ||
| <tr><td>receive (string)</td><td>やり取りされたMONA（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | <tr><td>receive (string)</td><td>やり取りされたMONA（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | ||
| <tr><td>res_lv (integer)</td><td>やり取りされたMONAをレベル分けしたもの。現状、レベルは0から7までの整数値です。</td></tr> | <tr><td>res_lv (integer)</td><td>やり取りされたMONAをレベル分けしたもの。現状、レベルは0から7までの整数値です。</td></tr> | ||
| <tr><td>rec_count (integer)</td><td>そのレスにMONAを送った人の数。</td></tr> | <tr><td>rec_count (integer)</td><td>そのレスにMONAを送った人の数。</td></tr> | ||
| <tr><td>host (string; nullable)</td><td>投稿した人のホスト情報。</td></tr> | |||
| <tr><td>response (string)</td><td>レス本文。</td></tr> | <tr><td>response (string)</td><td>レス本文。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="response_state">レスの状態について</h2> | |||
| <table class="api"> | |||
| <tr><th class="api_p">値</th><th class="api_d">状態</th></tr> | |||
| <tr><td>1</td><td>表示が可能</td></tr> | |||
| <tr><td>2</td><td>送金が可能</td></tr> | |||
| <tr><td>4</td><td>予備</td></tr> | |||
| <tr><td>8</td><td>予備</td></tr> | |||
| <tr><td>16</td><td>予備</td></tr> | |||
| <tr><td>32</td><td>予備</td></tr> | |||
| <tr><td>64</td><td>予備</td></tr> | |||
| <tr><td>128</td><td>予備</td></tr> | |||
| </table> | |||
| <h2 id="users_profile">プロフィール取得API</h2> | <h2 id="users_profile">プロフィール取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、特定のユーザーのプロフィールを取得することができます。</p> | <p>このAPIを使うと、特定のユーザーのプロフィールを取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>GET http://askmona.org/v1/users/profile</p> | <p>GET http://askmona.org/v1/users/profile</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>u_id (required)</td><td>ユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>ユーザーID。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>u_name (string)</td><td>ユーザーの名前。</td></tr> | <tr><td>u_name (string)</td><td>ユーザーの名前。</td></tr> | ||
| <tr><td>u_dan (string)</td><td>ユーザーの段位。</td></tr> | <tr><td>u_dan (string)</td><td>ユーザーの段位。</td></tr> | ||
| <tr><td>profile (string; nullable)</td><td>ユーザーのプロフィール。</td></tr> | <tr><td>profile (string; nullable)</td><td>ユーザーのプロフィール。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="topics_new">新規トピックAPI</h2> | |||
| <div class="txt"> | |||
| <p>このAPIを使うと、新たにトピックを立てることができます。</p> | |||
| </div> | |||
| <div class="txt"> | |||
| <p>POST http://askmona.org/v1/topics/new</p> | |||
| </div> | |||
| <table class="api"> | |||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | |||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | |||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | |||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | |||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | |||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | |||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | |||
| <tr><td>title (required)</td><td>トピックのタイトル。文字数32字以内という制約があります。</td></tr> | |||
| <tr><td>text (required)</td><td>トピックの本文。文字数は1024字以内、改行は15行以内という制約があります。</td></tr> | |||
| <tr><td>cat_id (default = 0)</td><td>トピックの<a href="#cat_id">カテゴリID</a>。</td></tr> | |||
| <tr><td>tags (optional)</td><td>トピックのタグ。１つのタグは12字以内、タグの総数は5つ以内という制約があります。</td></tr> | |||
| <tr><td>editable (default = 1)</td><td>第三者によるトピックの編集が可能かどうか。1は可能。0は禁止を意味します。</td></tr> | |||
| <tr><td>sh_host (default = 0)</td><td>投稿した人のホスト情報を表示するかどうか。0は非表示。1はID表示。2はID＋プロバイダ名表示を意味します。</td></tr> | |||
| </table> | |||
| <table class="api"> | |||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | |||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | |||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | |||
| </table> | |||
| <h2 id="topics_edit">トピック編集API</h2> | |||
| <div class="txt"> | |||
| <p>このAPIを使うと、トピックの編集をすることができます。</p> | |||
| </div> | |||
| <div class="txt"> | |||
| <p>POST http://askmona.org/v1/topics/edit</p> | |||
| </div> | |||
| <table class="api"> | |||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | |||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | |||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | |||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | |||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | |||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | |||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | |||
| <tr><td>t_id (required)</td><td>編集するトピックの、トピックID。</td></tr> | |||
| <tr><td>cat_id (optional)</td><td>トピックの<a href="#cat_id">カテゴリID</a>。</td></tr> | |||
| <tr><td>tags (optional)</td><td>トピックのタグ。１つのタグは12字以内、タグの総数は5つ以内という制約があります。</td></tr> | |||
| <tr><td>editable (optional)</td><td>第三者によるトピックの編集が可能かどうか。1は可能。0は禁止を意味します。</td></tr> | |||
| <tr><td>sh_host (optional)</td><td>投稿した人のホスト情報を表示するかどうか。0は非表示。1はID表示。2はID＋プロバイダ名表示を意味します。</td></tr> | |||
| </table> | |||
| <table class="api"> | |||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | |||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | |||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | |||
| </table> | |||
| <h2 id="responses_post">レス投稿API</h2> | <h2 id="responses_post">レス投稿API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、トピックに投稿することができます。</p> | <p>このAPIを使うと、トピックに投稿することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/responses/post</p> | <p>POST http://askmona.org/v1/responses/post</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>t_id (required)</td><td>投稿するトピックの、トピックID。</td></tr> | <tr><td>t_id (required)</td><td>投稿するトピックの、トピックID。</td></tr> | ||
| <tr><td>text (required)</td><td>レス本文。文字数は1024字以内、改行は15行以内という制約があります。</td></tr> | <tr><td>text (required)</td><td>レス本文。文字数は1024字以内、改行は15行以内という制約があります。</td></tr> | ||
| <tr><td>sage (default = 0)</td><td>1を指定した場合、sageが有効となります。</td></tr> | <tr><td>sage (default = 0)</td><td>1を指定した場合、sageが有効となります。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="users_myprofile">プロフィール変更API</h2> | <h2 id="users_myprofile">マイプロフィールAPI</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、プロフィールを変更することができます。</p> | <p>このAPIを使うと、自分のプロフィールを確認したり変更したりすることができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/users/myprofile</p> | <p>POST http://askmona.org/v1/users/myprofile</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>u_name (optional; either 'u_name' or 'profile' is required)</td><td>新しい名前。最大で12文字です。</td></tr> | <tr><td>u_name (optional)</td><td>新しい名前。最大で12文字です。</td></tr> | ||
| <tr><td>profile (optional; either 'u_name' or 'profile' is required)</td><td>新しいプロフィール。最大で255文字です。プロフィールを削除したい場合は、空文字列を指定してください。</td></tr> | <tr><td>profile (optional)</td><td>新しいプロフィール。最大で255文字です。プロフィールを削除したい場合は、空文字列を指定してください。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>u_name (string)</td><td>ユーザーの名前。</td></tr> | |||
| <tr><td>u_dan (string)</td><td>ユーザーの段位。</td></tr> | |||
| <tr><td>profile (string; nullable)</td><td>ユーザーのプロフィール。</td></tr> | |||
| <tr><td>state (integer)</td><td><a href="#user_state">ユーザーの権限</a>。ビットフラグで返されます。</td></tr> | |||
| <tr><td>class (integer)</td><td><a href="#user_class">ユーザーの属性</a>。ビットフラグで返されます。</td></tr> | |||
| </table> | |||
| <h2 id="user_state">ユーザーの権限について</h2> | |||
| <table class="api"> | |||
| <tr><th class="api_p">値</th><th class="api_d">権限</th></tr> | |||
| <tr><td>1</td><td>ログイン</td></tr> | |||
| <tr><td>2</td><td>送金</td></tr> | |||
| <tr><td>4</td><td>タグ編集</td></tr> | |||
| <tr><td>8</td><td>書き込み</td></tr> | |||
| <tr><td>16</td><td>トピック作成</td></tr> | |||
| <tr><td>32</td><td>出金</td></tr> | |||
| <tr><td>64</td><td>お気に入り編集・公開プロフィール編集</td></tr> | |||
| <tr><td>128</td><td>age（権限がないと強制sageになります）</td></tr> | |||
| </table> | |||
| <h2 id="user_class">ユーザーの属性について</h2> | |||
| <table class="api"> | |||
| <tr><th class="api_p">値</th><th class="api_d">属性</th></tr> | |||
| <tr><td>1</td><td>開発者（API利用可能）</td></tr> | |||
| <tr><td>2</td><td>予備</td></tr> | |||
| <tr><td>4</td><td>本人確認済✔</td></tr> | |||
| <tr><td>8</td><td>税務情報確認済</td></tr> | |||
| <tr><td>16</td><td>予備</td></tr> | |||
| <tr><td>32</td><td>管理者＊（レス・タグ管理）</td></tr> | |||
| <tr><td>64</td><td>上級管理者⁑（トピック・ユーザー管理）</td></tr> | |||
| <tr><td>128</td><td>最高管理者⁂（SQL発行）</td></tr> | |||
| </table> | </table> | ||
| <h2 id="favorites_list">お気に入り取得API</h2> | <h2 id="favorites_list">お気に入り取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、お気に入りに登録したトピックの一覧を取得すことができます。</p> | <p>このAPIを使うと、お気に入りに登録したトピックの一覧を取得すことができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/favorites/list</p> | <p>POST http://askmona.org/v1/favorites/list</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>order (default = 'added')</td><td>並べ替える条件。'added'はお気に入りに追加された時刻順、'updated'はトピックが更新された順で並べ替えられます。</td></tr> | <tr><td>order (default = 'added')</td><td>並べ替える条件。'added'はお気に入りに追加された時刻順、'updated'はトピックが更新された順で並べ替えられます。</td></tr> | ||
| <tr><td>limit (default = 200)</td><td>取得するお気に入りの個数。最大値は200です。</td></tr> | <tr><td>limit (default = 200)</td><td>取得するお気に入りの個数。最大値は200です。</td></tr> | ||
| <tr><td>offset (default = 0)</td><td>取得するお気に入りのオフセット（取得開始位置）。最大値は200です。</td></tr> | <tr><td>offset (default = 0)</td><td>取得するお気に入りのオフセット（取得開始位置）。最大値は200です。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>topics (list)</td><td><a href="#topic_object">トピックオブジェクト</a>のリスト。</td></tr> | <tr><td>topics (list)</td><td><a href="#topic_object">トピックオブジェクト</a>のリスト。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="favorites_add">お気に入り追加API</h2> | <h2 id="favorites_add">お気に入り追加API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、トピックをお気に入りに追加することができます。</p> | <p>このAPIを使うと、トピックをお気に入りに追加することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/favorites/add</p> | <p>POST http://askmona.org/v1/favorites/add</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>t_id (required)</td><td>お気に入りに追加するトピックの、トピックID。現在のところ、お気に入りの数が100以上の場合、それ以上追加できない仕様になっています。</td></tr> | <tr><td>t_id (required)</td><td>お気に入りに追加するトピックの、トピックID。現在のところ、お気に入りの数が100以上の場合、それ以上追加できない仕様になっています。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="favorites_delete">お気に入り削除API</h2> | <h2 id="favorites_delete">お気に入り削除API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、トピックをお気に入りから削除することができます。</p> | <p>このAPIを使うと、トピックをお気に入りから削除することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/favorites/delete</p> | <p>POST http://askmona.org/v1/favorites/delete</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>t_id (required)</td><td>お気に入りから削除するトピックの、トピックID。</td></tr> | <tr><td>t_id (required)</td><td>お気に入りから削除するトピックの、トピックID。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="account_deposit">MONA入金アドレス取得API</h2> | <h2 id="account_deposit">MONA入金アドレス取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、Ask MonaにMONAを入金する際のMonacoinアドレスを取得することができます。</p> | <p>このAPIを使うと、Ask MonaにMONAを入金する際のMonacoinアドレスを取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/account/deposit</p> | <p>POST http://askmona.org/v1/account/deposit</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>d_address (string)</td><td>Ask MonaにMONAを入金する際のMonacoinアドレス。このアドレスにMONAを送っていただくと、入金ができます。</td></tr> | <tr><td>d_address (string)</td><td>Ask MonaにMONAを入金する際のMonacoinアドレス。このアドレスにMONAを送っていただくと、入金ができます。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="account_withdraw">MONA出金依頼API</h2> | <h2 id="account_withdraw">MONA出金依頼API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、MONAの出金手続を行うことができます。</p> | <p>このAPIを使うと、MONAの出金手続を行うことができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/account/withdraw</p> | <p>POST http://askmona.org/v1/account/withdraw</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>amount (required)</td><td>出金したいMONAの額。watanabe単位で指定してください（1MONAは100,000,000watanabeで、amountは整数値をとります）。たとえば、12MONAを出金したい場合は、amount='1200000000'となります。指定した額から手数料（0.01MONA）を差し引いた額が、登録したアドレスに送付されます。なお、仕様により、一度に100万MONA以上の額は出金できません。</td></tr> | <tr><td>amount (required)</td><td>出金したいMONAの額。watanabe単位で指定してください（1MONAは100,000,000watanabeで、amountは整数値をとります）。たとえば、12MONAを出金したい場合は、amount='1200000000'となります。指定した額から手数料（0.01MONA）を差し引いた額が、登録したアドレスに送付されます。なお、仕様により、一度に100万MONA以上の額は出金できません。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>balance (string)</td><td>出金後のMONA残高（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | <tr><td>balance (string)</td><td>出金後のMONA残高（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="account_send">MONA送金API</h2> | <h2 id="account_send">MONA送金API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、特定のレス、または特定のユーザーにMONAを送金することができます。</p> | <p>このAPIを使うと、特定のレス、または特定のユーザーにMONAを送金することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/account/send</p> | <p>POST http://askmona.org/v1/account/send</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td>signature (optional)</td><td><a href="#send_signature">送金リクエストに対する署名</a>。現在のところ署名がなくても送金できます。</td></tr> | <tr><td>signature (optional)</td><td><a href="#send_signature">送金リクエストに対する署名</a>。現在のところ署名がなくても送金できます。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>to_u_id (optional; either 'to_u_id' or 't_id' is required)</td><td>送金したい相手のユーザーID。送金したいレスを指定しない場合、必須項目となります。また、送金したいレスを指定した場合、このパラメータは無視されます。</td></tr> | <tr><td>to_u_id (optional; either 'to_u_id' or 't_id' is required)</td><td>送金したい相手のユーザーID。送金したいレスを指定しない場合、必須項目となります。また、送金したいレスを指定した場合、このパラメータは無視されます。</td></tr> | ||
| <tr><td>t_id (optional; either 'to_u_id' or 't_id' is required)</td><td>送金したいレスの、トピックID。送金したいユーザーを指定しない場合、必須項目となります。</td></tr> | <tr><td>t_id (optional; either 'to_u_id' or 't_id' is required)</td><td>送金したいレスの、トピックID。送金したいユーザーを指定しない場合、必須項目となります。</td></tr> | ||
| <tr><td>r_id (optional unless 't_id' is set)</td><td>送金したいレスの、レス番号。t_idを指定した場合、必須項目となります。</td></tr> | <tr><td>r_id (optional unless 't_id' is set)</td><td>送金したいレスの、レス番号。t_idを指定した場合、必須項目となります。</td></tr> | ||
| <tr><td>amount (required)</td><td>送金したいMONAの額。watanabe単位で指定してください（1MONAは100,000,000watanabeで、amountは整数値をとります）。たとえば、12MONAを送りたい場合は、amount='1200000000'となります。また、仕様により、一度に100万MONA以上の額は送れません。</td></tr> | <tr><td>amount (required)</td><td>送金したいMONAの額。watanabe単位で指定してください（1MONAは100,000,000watanabeで、amountは整数値をとります）。たとえば、12MONAを送りたい場合は、amount='1200000000'となります。また、仕様により、一度に100万MONA以上の額は送れません。</td></tr> | ||
| <tr><td>anonymous (default = 1)</td><td>匿名で送金するかどうか。0を指定した場合、ユーザーIDとユーザー名を送金相手に知らせることができます。1を指定した場合、匿名で送金します。</td></tr> | <tr><td>anonymous (default = 1)</td><td>匿名で送金するかどうか。0を指定した場合、ユーザーIDとユーザー名を送金相手に知らせることができます。1を指定した場合、匿名で送金します。</td></tr> | ||
| <tr><td>msg_text (optional)</td><td>メッセージ。anonymousに1を指定したとき、送金相手にメッセージを送ることができます。メッセージは255字以内である必要があります。</td></tr> | |||
| <tr><td>sage (default = 0)</td><td>1を指定した場合、sageが有効となります。</td></tr> | <tr><td>sage (default = 0)</td><td>1を指定した場合、sageが有効となります。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>balance (string)</td><td>送金後のMONA残高（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | <tr><td>balance (string)</td><td>送金後のMONA残高（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="send_signature">送金リクエストに対する署名の作成方法</h2> | <h2 id="send_signature">送金リクエストに対する署名の作成方法</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>現在のところ署名がなくても送金できますが、リクエストに署名したい方は、以下の署名を利用できます。</p> | <p>現在のところ署名がなくても送金できますが、リクエストに署名したい方は、以下の署名を利用できます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p><?php //phpのサンプルコード<br>$mac_key = $app_secretkey.$secretkey;<br>$base_string = isset($t_id) ?<br>//レスを指定して送る場合<br> '{"t_id":"'.$t_id.'","r_id":"'.$r_id.'","amount":"'.$amount.'"}':<br>//ユーザーIDを指定して送る場合<br> '{"to_u_id":"'.$to_u_id.'","amount":"'.$amount.'"}';<br>//$signatureが署名です。<br>$signature = base64_encode(hash_hmac('sha256',$base_string.$nonce.$time,$mac_key,TRUE));</p> | <p><?php //phpのサンプルコード<br>$mac_key = $app_secretkey.$secretkey;<br>$base_string = isset($t_id) ?<br>//レスを指定して送る場合<br> '{"t_id":"'.$t_id.'","r_id":"'.$r_id.'","amount":"'.$amount.'"}':<br>//ユーザーIDを指定して送る場合<br> '{"to_u_id":"'.$to_u_id.'","amount":"'.$amount.'"}';<br>//$signatureが署名です。<br>$signature = base64_encode(hash_hmac('sha256',$base_string.$nonce.$time,$mac_key,TRUE));</p> | ||
| </div> | </div> | ||
| <h2 id="account_balance">残高取得API</h2> | <h2 id="account_balance">残高取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、ユーザーの残高に関する情報を取得することができます。</p> | <p>このAPIを使うと、ユーザーの残高に関する情報を取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/account/balance</p> | <p>POST http://askmona.org/v1/account/balance</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>detail (default = 0)</td><td>個別の勘定を取得するかどうか。0を指定した場合取得しません。1を指定した場合、個別の勘定を取得します。</td></tr> | <tr><td>detail (default = 0)</td><td>個別の勘定を取得するかどうか。0を指定した場合取得しません。1を指定した場合、個別の勘定を取得します。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>balance (string)</td><td>現在のMONA残高（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | <tr><td>balance (string)</td><td>現在のMONA残高（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | ||
| <tr><td>accounts (object)</td><td><a href="#accounts_object">個別勘定オブジェクト</a>。detailに1を指定した場合のみ返却されます。</td></tr> | <tr><td>accounts (object)</td><td><a href="#accounts_object">個別勘定オブジェクト</a>。detailに1を指定した場合のみ返却されます。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="accounts_object">個別勘定オブジェクトについて</h2> | <h2 id="accounts_object">個別勘定オブジェクトについて</h2> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>deposit (string)</td><td>入金済みのMONA（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | <tr><td>deposit (string)</td><td>入金済みのMONA（watanabe単位 1MONAは100,000,000watanabeです）。</td></tr> | ||
| <tr><td>send (string)</td><td>ばらまいたMONA（watanabe単位）。</td></tr> | <tr><td>send (string)</td><td>ばらまいたMONA（watanabe単位）。</td></tr> | ||
| <tr><td>receive (string)</td><td>受け取ったMONA（watanabe単位）。</td></tr> | <tr><td>receive (string)</td><td>受け取ったMONA（watanabe単位）。</td></tr> | ||
| <tr><td>withdraw (string)</td><td>出金済みのMONA（watanabe単位）。</td></tr> | <tr><td>withdraw (string)</td><td>出金済みのMONA（watanabe単位）。</td></tr> | ||
| <tr><td>gift (string)</td><td>運営から受け取ったMONA（watanabe単位）。</td></tr> | <tr><td>gift (string)</td><td>運営から受け取ったMONA（watanabe単位）。</td></tr> | ||
| <tr><td>reserved (string)</td><td>一時預かり中のMONA（watanabe単位）。</td></tr> | <tr><td>reserved (string)</td><td>一時預かり中のMONA（watanabe単位）。</td></tr> | ||
| <tr><td>balance (string)</td><td>現在のMONA残高（watanabe単位）。なお、balance = deposit - send + receive - withdraw + gift - reservedが成立します。</td></tr> | <tr><td>balance (string)</td><td>現在のMONA残高（watanabe単位）。なお、balance = deposit - send + receive - withdraw + gift - reservedが成立します。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="account_txdetail">取引明細取得API</h2> | <h2 id="account_txdetail">取引明細取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、ユーザーの個別の取引についての情報を取得することができます。</p> | <p>このAPIを使うと、ユーザーの個別の取引についての情報を取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/account/txdetail</p> | <p>POST http://askmona.org/v1/account/txdetail</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | <tr><td style="padding:2px"></td><td style="padding:2px"></td></tr> | ||
| <tr><td>item (default = 'receive')</td><td>勘定科目。'deposit'は入金、'withdraw'は出金、'receive'は受け取り、'send'はばらまきを意味します。</td></tr> | <tr><td>item (default = 'receive')</td><td>勘定科目。'deposit'は入金、'withdraw'は出金、'receive'は受け取り、'send'はばらまきを意味します。</td></tr> | ||
| <tr><td>limit (default = 200)</td><td>取得する取引明細の数。最大値は200です。</td></tr> | <tr><td>limit (default = 200)</td><td>取得する取引明細の数。最大値は200です。</td></tr> | ||
| <tr><td>offset (default = 0)</td><td>取得する取引明細のオフセット（取得開始位置）。最大値は800です。</td></tr> | <tr><td>offset (default = 0)</td><td>取得する取引明細のオフセット（取得開始位置）。最大値は800です。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>transactions (list)</td><td><a href="#transaction_object">取引明細オブジェクト</a>のリスト。</td></tr> | <tr><td>transactions (list)</td><td><a href="#transaction_object">取引明細オブジェクト</a>のリスト。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="transaction_object">取引明細オブジェクトについて</h2> | <h2 id="transaction_object">取引明細オブジェクトについて</h2> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>created (integer)</td><td>取引が処理された時刻（UNIX時刻）。</td></tr> | <tr><td>created (integer)</td><td>取引が処理された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>item (string)</td><td>取引の勘定科目。</td></tr> | <tr><td>item (string)</td><td>取引の勘定科目。</td></tr> | ||
| <tr><td>amount (string)</td><td>取引されたMONA（watanabe単位）。</td></tr> | <tr><td>amount (string)</td><td>取引されたMONA（watanabe単位）。</td></tr> | ||
| <tr><td>t_id (integer; nullable)</td><td>取引の原因となったトピックID。レスに対して送金が行われたときのみ返します。</td></tr> | <tr><td>t_id (integer; nullable)</td><td>取引の原因となったトピックID。レスに対して送金が行われたときのみ返します。</td></tr> | ||
| <tr><td>r_id (integer; nullable)</td><td>取引の原因となったレス番号。レスに対して送金が行われたときのみ返します。</td></tr> | <tr><td>r_id (integer; nullable)</td><td>取引の原因となったレス番号。レスに対して送金が行われたときのみ返します。</td></tr> | ||
| <tr><td>anonymous (integer; nullable)</td><td>匿名送金かどうか。1は匿名送金、0は通知送金を意味します。勘定科目が'receive'、または'send'のときのみ返されます。</td></tr> | <tr><td>anonymous (integer; nullable)</td><td>匿名送金かどうか。1は匿名送金、0は通知送金を意味します。勘定科目が'receive'、または'send'のときのみ返されます。</td></tr> | ||
| <tr><td>user (object; nullable)</td><td>取引の相手方の<a href="#user_object">ユーザーオブジェクト</a>。勘定科目が'receive'で匿名送金でないとき、または勘定科目が'send'のときのみ返されます。</td></tr> | <tr><td>user (object; nullable)</td><td>取引の相手方の<a href="#user_object">ユーザーオブジェクト</a>。勘定科目が'receive'で匿名送金でないとき、または勘定科目が'send'のときのみ返されます。</td></tr> | ||
| <tr><td>msg_text (string; nullable)</td><td>メッセージ。</td></tr> | |||
| </table> | </table> | ||
| <h2 id="user_object">ユーザーオブジェクトについて</h2> | <h2 id="user_object">ユーザーオブジェクトについて</h2> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>u_id (integer)</td><td>ユーザーID。</td></tr> | <tr><td>u_id (integer)</td><td>ユーザーID。</td></tr> | ||
| <tr><td>u_name (string)</td><td>名前。</td></tr> | <tr><td>u_name (string)</td><td>名前。</td></tr> | ||
| <tr><td>u_dan (string)</td><td>段位。</td></tr> | <tr><td>u_dan (string)</td><td>段位。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="auth_verify">シークレットキー検証API</h2> | <h2 id="auth_verify">シークレットキー検証API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、認証キーの作成に使うシークレットキーが有効か判断できます。有効かどうかは、すべての要認証APIのエラー情報から確かめられますので、通常は他のAPIを使用して検証してください。なお、有効でない場合は、要認証API利用チャートの手順2からやり直してください。</p> | <p>このAPIを使うと、認証キーの作成に使うシークレットキーが有効か判断できます。有効かどうかは、すべての要認証APIのエラー情報から確かめられますので、通常は他のAPIを使用して検証してください。なお、有効でない場合は、要認証API利用チャートの手順2からやり直してください。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/auth/verify</p> | <p>POST http://askmona.org/v1/auth/verify</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | <tr><td>app_id (required)</td><td>アプリケーションID（開発者のユーザーID）。</td></tr> | ||
| <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (required)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | <tr><td>nonce (required)</td><td>ランダムな文字列。リクエストごとに変更してください。</td></tr> | ||
| <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | <tr><td>time (required)</td><td>nonceが生成された時刻（UNIX時刻）。</td></tr> | ||
| <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | <tr><td>auth_key (required)</td><td><a href="#auth_key">認証キー</a>。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。利用者がアプリ連携していない、または連携を取り消したため、認証キーの作成に使うシークレットキーが無効の場合、'Secret key unavailable'を返します。アプリ連携はしているが、認証キーが一致しない場合は、'Invalid auth_key'を返します。これらの表示は、すべての要認証APIにおいて共通です。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。利用者がアプリ連携していない、または連携を取り消したため、認証キーの作成に使うシークレットキーが無効の場合、'Secret key unavailable'を返します。アプリ連携はしているが、認証キーが一致しない場合は、'Invalid auth_key'を返します。これらの表示は、すべての要認証APIにおいて共通です。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="auth_key">認証キーの作成方法</h2> | <h2 id="auth_key">認証キーの作成方法</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>開発者シークレットキー、nonce、time、認証キーの作成に使うシークレットキーの順に連結した文字列をSHA-256でハッシュ化し、そのバイナリデータをBase64でエンコードしたものが認証キーです。</p> | <p>開発者シークレットキー、nonce、time、認証キーの作成に使うシークレットキーの順に連結した文字列をSHA-256でハッシュ化し、そのバイナリデータをBase64でエンコードしたものが認証キーです。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p><?php //phpのサンプルコード<br>$app_secretkey = 'API利用登録の際に発行された、開発者シークレットキー';<br>$secretkey = '認証キーの作成に使うシークレットキー';<br>$nonce = base64_encode(mcrypt_create_iv(32,MCRYPT_DEV_URANDOM));<br>$time = time();<br>//$auth_keyが認証キーです。<br>$auth_key = base64_encode(hash('sha256',$app_secretkey.$nonce.$time.$secretkey,TRUE));</p> | <p><?php //phpのサンプルコード<br>$app_secretkey = 'API利用登録の際に発行された、開発者シークレットキー';<br>$secretkey = '認証キーの作成に使うシークレットキー';<br>$nonce = base64_encode(mcrypt_create_iv(32,MCRYPT_DEV_URANDOM));<br>$time = time();<br>//$auth_keyが認証キーです。<br>$auth_key = base64_encode(hash('sha256',$app_secretkey.$nonce.$time.$secretkey,TRUE));</p> | ||
| </div> | </div> | ||
| <h2 id="auth_signup">Ask Mona登録API</h2> | <h2 id="auth_signup">Ask Mona登録API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、新しくAsk Monaにアカウントを作成することができます。また、自動的にアプリケーション連携を行い、認証キーの作成に使うシークレットキーを取得することができます。</p> | <p>このAPIを使うと、新しくAsk Monaにアカウントを作成することができます。また、自動的にアプリケーション連携を行い、認証キーの作成に使うシークレットキーを取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/auth/signup</p> | <p>POST http://askmona.org/v1/auth/signup</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>開発者のユーザーID。</td></tr> | <tr><td>app_id (required)</td><td>開発者のユーザーID。</td></tr> | ||
| <tr><td>app_secretkey (required)</td><td>API利用登録の際に発行された、開発者シークレットキー。</td></tr> | <tr><td>app_secretkey (required)</td><td>API利用登録の際に発行された、開発者シークレットキー。</td></tr> | ||
| <tr><td>u_address (required)</td><td>利用者が登録に使うMonacoinアドレス。</td></tr> | <tr><td>u_address (required)</td><td>利用者が登録に使うMonacoinアドレス。</td></tr> | ||
| <tr><td>u_name (optional)</td><td>利用者の名前。最大で12文字です。指定しない場合は「名無し」となります。</td></tr> | <tr><td>u_name (optional)</td><td>利用者の名前。最大で12文字です。指定しない場合は「名無し」となります。</td></tr> | ||
| <tr><td>pass (required)</td><td>利用者が登録に使うパスワード。6字以上で指定してください。</td></tr> | <tr><td>pass (required)</td><td>利用者が登録に使うパスワード。6字以上で指定してください。</td></tr> | ||
| <tr><td>agree (default = 0)</td><td>Ask Mona利用規約に同意するかどうか。同意する場合、1を指定して下さい。同意しない場合は登録できません。</td></tr> | <tr><td>agree (default = 0)</td><td>Ask Mona利用規約に同意するかどうか。同意する場合、1を指定して下さい。同意しない場合は登録できません。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>u_id (integer)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (integer)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>secretkey (string)</td><td>認証キーの作成に使うシークレットキー。</td></tr> | <tr><td>secretkey (string)</td><td>認証キーの作成に使うシークレットキー。</td></tr> | ||
| </table> | </table> | ||
| <h2 id="auth_secretkey">シークレットキー取得API</h2> | <h2 id="auth_secretkey">シークレットキー取得API</h2> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>このAPIを使うと、自動的にアプリケーション連携を行い、認証キーの作成に使うシークレットキーを取得することができます。</p> | <p>このAPIを使うと、自動的にアプリケーション連携を行い、認証キーの作成に使うシークレットキーを取得することができます。</p> | ||
| </div> | </div> | ||
| <div class="txt"> | <div class="txt"> | ||
| <p>POST http://askmona.org/v1/auth/secretkey</p> | <p>POST http://askmona.org/v1/auth/secretkey</p> | ||
| </div> | </div> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">パラメータ</th><th class="api_d">説明</th></tr> | ||
| <tr><td>app_id (required)</td><td>開発者のユーザーID。</td></tr> | <tr><td>app_id (required)</td><td>開発者のユーザーID。</td></tr> | ||
| <tr><td>app_secretkey (required)</td><td>API利用登録の際に発行された、開発者シークレットキー。</td></tr> | <tr><td>app_secretkey (required)</td><td>API利用登録の際に発行された、開発者シークレットキー。</td></tr> | ||
| <tr><td>u_address (required)</td><td>利用者のMonacoinアドレス。</td></tr> | <tr><td>u_address (required)</td><td>利用者のMonacoinアドレス。</td></tr> | ||
| <tr><td>pass (required)</td><td>利用者のパスワード。</td></tr> | <tr><td>pass (required)</td><td>利用者のパスワード。</td></tr> | ||
| </table> | </table> | ||
| <table class="api"> | <table class="api"> | ||
| <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | <tr><th class="api_p">レスポンス</th><th class="api_d">説明</th></tr> | ||
| <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | <tr><td>status (integer)</td><td>結果。1は成功、0は失敗を意味します。</td></tr> | ||
| <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | <tr><td>error (string)</td><td>エラーの場合の追加情報。</td></tr> | ||
| <tr><td>u_id (integer)</td><td>利用者のユーザーID。</td></tr> | <tr><td>u_id (integer)</td><td>利用者のユーザーID。</td></tr> | ||
| <tr><td>secretkey (string)</td><td>認証キーの作成に使うシークレットキー。</td></tr> | <tr><td>secretkey (string)</td><td>認証キーの作成に使うシークレットキー。</td></tr> | ||
| </table> | </table> | ||