Ohayoo Public API

Ohayoo Public API

Ohayoo APIは、以下の形式をとります。APIのリクエストは、必ずhttpsで呼ばれる必要があります。下記の共通パラメータ以外に、APIごとにAPI固有のパラメータを取ります。

https://ohayoo.info/rest/(API_NAME).view?u=(USERNAME)&p=(PASSWORD)&v=(VERSION)&c=(APPNAME)&f=(FORMAT)

例:https://ohayoo.info/rest/ping.view?u=username&p=password&v=1.10.2&c=myapp&f=json

APIの名前一覧

(API_NAME)に、APIの名前が入ります。

APIの名称 内容
createUser 新規ユーザを作成
deleteFile 宣言を削除する
getAvatar アバター画像を取得する
getCommentOnStar 宣言に対する他のユーザからのメッセージを取得する
getSong 宣言の情報を取得する
getSongsByStar チアーされてるものの多い順に宣言の一覧を取得する
getSongsWithNumber 特定の番号の宣言を取得する
getSpecifiedUserSongs 特定のユーザの宣言の一覧を取得する
getStarred そのユーザがチアーしている宣言の一覧の取得
getUserSongs 自分の宣言の一覧を取得する
ping サーバへの接続の有無の確認
recoverUser パスワードの再発行
removeStarred チアーを取り消す
resetCompleted 宣言が進行中であることを記録
setAlarm 問題ある宣言を報告する
setAlarmToUser 問題あるユーザを報告する
setAvatarSchemeCustom カスタムアバターを利用する
setAvatarSchemeNone デフォルトアバターを利用する
setCompleted 宣言を達成したことを記録
setPrivate 宣言を非公開にする
setPublic 宣言を公開する
star チアーする
stream 宣言をストリームする
unstar チアーを取り消す
upload 宣言をアップロードする
uploadAvatar アバターをアップロードする

 共通パラメータ

パラメータ 必須/任意 説明
u 必須 ユーザ名
p 必須 パスワード
v 必須 プロトコルのバージョン(1.10.2)
c 必須 クライアント固有の文字列
f 任意 レスポンスデータのフォーマット ”xml”または”json” デフォルトはxml

ユーザ名および、パスワードはOhayooアプリ内でユーザ登録(無料)をすることにより取得できます。ユーザ登録にあたっては、「Ohayoo使用許諾契約」への同意が必要です。「Ohayoo Public APIご利用上の遵守事項」も合わせてご確認の上、ご利用下さい。