Index

APIドキュメント

もくじ

概要
リクエスト
  1. トークン取得
  2. リスト取得
  3. 個々のアンケートを取得
  4. アンケートを作成
  5. アンケートに投票
  6. アンケートを修正
  7. アンケートを削除
  8. 名前の変更
authテキストの種類
レスポンス
  1. vote
  2. details
  3. type
  4. result
  5. error

概要

POSTメソッドで送信してください。
JSON形式で送信してください。
auth requiredな時はtokenにトークンを入れて送信してください。
ルーター等は使ってないので、リクエストのURLは必ず"/"で終わる必要があります。
statusとエラーハンドリングについてはerrorを参照
APIにバージョニングがないって正気ですか?

リクエスト

トークン取得
POST /vote_api/login/connect/

access_tokenには、domainで/api/v1/accounts/verify_credentialsができる権限のものを入れてください。 tokenはこの先必要です(有効期限:無期限)。安全に保管してください。なお、votedon.のサーバーにはMastodonのアクセストークンは保存されません。
nameは初期値では完全なacct(Cutls@kirishima.cloudなど)です。別APIで変更できます。

リスト取得
POST /vote_api/list/

tokenは必須ではありません。すべての公開アンケートとtokenで識別する自分のアンケートを取得します。 votesにはvoteを1つ以上並べた配列が返ります。

個々のアンケートを取得
POST /vote_api/get/

tokenは必須ではありません。 dataにはdetailsが返ります。

アンケートを作成
POST /vote_api/make/

nameは20文字以上が自動で切り取られます。choicesには選択肢の文字列を配列にして渡してください。20文字以上が自動で切り取られ、空欄は無視されます。選択肢は2以上10以下である必要があります。
expired_atにはISO 8601タイムスタンプをUTC(+0:00)。現在時刻より60秒以上後の値を指定してください。Tokyo(+9:00)などでも解釈されますが、不具合を防ぐためにUTCでお願いします。
authauthの書式に従ってください。listedはトップページに掲載するかどうかを、resultはすぐに結果を表示するかどうかを入れてください。
voteにはvoteが返ります。

アンケートに投票
POST /vote_api/vote/

idは投票権のある(type->have_permissionがtrue)、終了していないアンケートである必要があります。
choiceには、選択肢配列を順に0から番号付けしたものを入れてください。

アンケートを修正
POST /vote_api/make/modify/

idは自分の作成したアンケートである必要があります。
expired_atにはISO 8601タイムスタンプをUTC(+0:00)で入力してください。現在時刻より60秒以上後の値を指定してください。Tokyo(+9:00)などでも解釈されますが、不具合を防ぐためにUTCでお願いします。

アンケートを削除
POST /vote_api/delete/

idは自分の作成したアンケートである必要があります。

自分の名前を編集
POST /vote_api/delete/

idは自分の作成したアンケートである必要があります。
nameは50文字以上が自動で切り取られます。

authの種類

レスポンス

vote
details
type
result
error
statusがerrorのとき、dataに英語で、data_jaに日本語でエラー文が返ります。

© Cutls P 2019