https://api.yamareco.com/api/v1/
本APIを利用する場合、すべて上記のアドレス配下にアクセスいただくことになります。
例えば、記録を登録する場合は、
https://api.yamareco.com/api/v1/createRec
になります。
リクエストのパラメータはHTTP POSTで渡します。
日本語はUTF-8でエンコーディングする必要があります。
レスポンスはJSON形式で返答があります。
HTTPのプロトコルにおいてエラーが発生した場合は、HTTPのエラーが返されます。
サーバ側の処理に成功した場合は、JSONのerrパラメータが0で返答されます。
サーバ側で処理に失敗した場合は、JSONのerrパラメータが1になり、errcodeパラメータにエラー要因のコード(文字列)が返されます。
下記7つのAPIについては、OAuthの認証なしでご利用いただけます。
・エリアリストの取得(getArealist)
・ジャンルリストの取得(getGenrelist)
・記録リストの取得(getReclist)
・地名データの検索(searchPoi)
・近隣の地名データ一覧(nearbyPoi)
・地名データのデータ種別リストの取得(getTypelist)
上記以外のAPIにはOAuth認証が必要です。
OAuth認証が必要なAPIについて、セッションの有効期限切れもしくはサーバ側のセッションデータが削除されたあとに各APIにアクセスした場合は、認証エラー(HTTP 403)が返答されます。
認証エラーが起きた場合はOAuth認証によりアクセストークンを再取得してください。