API Document

墓では api/v1/ 以下に API が生えています。 レスポンスの形式は JSON になります。 線香を上げる以外は認証は必要ありません。

GET incenses

みんなの上げた線香の一覧が取得できます。一度に 50 件まで取得でき、page パラメータを 使用することで更に過去のものも取得できます。

response で取得できる next_page や prev_page が null でない場合はその数字を page パラメータに指定することにより、次の 50 件や前の 50 件が取得できます。

Resource URL

http://haka.yamashi.ro/api/v1/incenses

Parameters

パラメータ名 説明

page
optional

ページネーションのための数字を指定します。 何も指定しなかった場合は 1 を指定したことになります。

Example Request 
$ curl http://haka.yamashi.ro/api/v1/incenses | jq .
{
  "incenses": [
    {
      "created_at": "2015-02-25T22:04:48.054+09:00",
      "user": {
        "name": "Yoshiori SHOJI",
        "nickname": "yoshiori",
        "image": "https://avatars.githubusercontent.com/u/78609?v=3",
        "created_at": "2015-02-25T22:04:41.023+09:00"
      }
    },
    {
      "created_at": "2015-02-24T00:00:00.000+09:00",
      "user": {
        "name": "Yoshiori SHOJI",
        "nickname": "yoshiori",
        "image": "https://avatars.githubusercontent.com/u/78609?v=3",
        "created_at": "2015-02-25T22:04:41.023+09:00"
      }
    }
  ],
  "total_count": 2,
  "num_pages": 1,
  "current_page": 1,
  "next_page": null,
  "prev_page": null
}

POST incenses

線香を上げることが出来ます。この API のみ認証が必要になります。 認証は アカウントごとに発行された token を付けることにより行います。

response の status code によって成功したかどうかを判断できます

Resource URL

http://haka.yamashi.ro/api/v1/incenses

Parameters

パラメータ名 説明

token
required

 認証のための token を指定します。 token は 下記 で発行 & 確認できます。

Example Request 
$ curl -d token=xxxxxx http://haka.yamashi.ro/api/v1/incenses

Error Codes & Responses
HTTP Status Codes

コード 説明

201
Created

 正常に線香を上げれた

400
Bad Request

 token を指定してない

401
Unauthorized

 token が間違っている

409
Conflict

 すでに今日は線香をあげている

GET users/:nickname

ユーザー情報を取得します

Resource URL

http://haka.yamashi.ro/api/v1/users/:nickname

Example Request 
$ curl http://haka.yamashi.ro/api/v1/users/yoshiori | jq .
{
  "user": {
    "name": "Yoshiori SHOJI",
    "nickname": "yoshiori",
    "image": "https://avatars.githubusercontent.com/u/78609?v=3",
    "created_at": "2015-03-02T20:48:03.755+09:00"
  }
}

GET users/:nickname/incenses

nickname の上げた線香の一覧が取得できます。パラメータやレスポンスなどは GET incenses と同じです。

Resource URL

http://haka.yamashi.ro/api/v1/users/:nickname/incenses

Example Request 
$ curl http://haka.yamashi.ro/api/v1/users/yoshiori/incenses | jq .
{
  "incenses": [
    {
      "created_at": "2015-02-25T22:04:48.054+09:00",
      "user": {
        "name": "Yoshiori SHOJI",
        "nickname": "yoshiori",
        "image": "https://avatars.githubusercontent.com/u/78609?v=3",
        "created_at": "2015-02-25T22:04:41.023+09:00"
      }
    },
    {
      "created_at": "2015-02-24T00:00:00.000+09:00",
      "user": {
        "name": "Yoshiori SHOJI",
        "nickname": "yoshiori",
        "image": "https://avatars.githubusercontent.com/u/78609?v=3",
        "created_at": "2015-02-25T22:04:41.023+09:00"
      }
    }
  ],
  "total_count": 2,
  "num_pages": 1,
  "current_page": 1,
  "next_page": null,
  "prev_page": null
}

API Token