Download OpenAPI specification:Download
夜のライフログサービス Tissue の公開API仕様です。
全てのAPIのURLは https://shikorism.net/api から始まります。
一部APIではドキュメントに無いプロパティを応答する場合がありますが、これは正式な仕様ではありません。 予告なく削除する可能性がありますので使用しないでください。
Webhook IDを発行したユーザで新規チェックインを行います。
| id required | string Webhook管理ページで発行したID |
| checked_in_at | string <date-time> チェックイン日時 |
| tags | Array of strings[ items <= 255 characters ] タグ |
| link | string <= 2000 characters オカズリンク (http, https) |
| note | string <= 500 characters ノート |
| is_private | boolean Default: false 非公開チェックインとして設定 |
| is_too_sensitive | boolean Default: false チェックイン対象のオカズをより過激なオカズとして設定 |
| discard_elapsed_time | boolean Default: false 前回チェックインからの経過時間を記録しない |
何も指定しなければ、現在時刻で公開チェックインをおこないます。
{ }{- "status": 200,
- "checkin": {
- "id": 0,
- "checked_in_at": "2020-07-21T19:19:19+0900",
- "tags": [
- "Example",
- "Example_2"
], - "note": "すごく出た",
- "is_private": false,
- "is_too_sensitive": false,
- "discard_elapsed_time": false,
- "source": "api"
}
}{- "name": "string",
- "display_name": "string",
- "is_protected": true,
- "private_likes": true,
- "bio": "string",
- "checkin_summary": {
- "current_session_elapsed": 0,
- "total_checkins": 0,
- "total_times": 0,
- "average_interval": 0,
- "longest_interval": 0,
- "shortest_interval": 0
}
}{- "name": "string",
- "display_name": "string",
- "is_protected": true,
- "private_likes": true,
- "bio": "string",
- "checkin_summary": {
- "current_session_elapsed": 0,
- "total_checkins": 0,
- "total_times": 0,
- "average_interval": 0,
- "longest_interval": 0,
- "shortest_interval": 0
}
}指定したユーザーのチェックイン一覧を取得します。
| name required | string ユーザー名 |
| page | integer Default: 1 ページ番号 |
| per_page | integer [ 10 .. 100 ] Default: 20 1ページあたりのアイテム数 |
| has_link | boolean Default: false オカズリンクを含むチェックインのみ取得 |
[- {
- "id": 0,
- "checked_in_at": "2020-07-21T19:19:19+0900",
- "tags": [
- "Example",
- "Example_2"
], - "note": "すごく出た",
- "is_private": false,
- "is_too_sensitive": false,
- "discard_elapsed_time": false,
- "source": "api"
}
]新規チェックインを行います。
| checked_in_at | string <date-time> チェックイン日時 |
| tags | Array of strings[ items <= 255 characters ] タグ |
| link | string <= 2000 characters オカズリンク (http, https) |
| note | string <= 500 characters ノート |
| is_private | boolean Default: false 非公開チェックインとして設定 |
| is_too_sensitive | boolean Default: false チェックイン対象のオカズをより過激なオカズとして設定 |
| discard_elapsed_time | boolean Default: false 前回チェックインからの経過時間を記録しない |
全てのプロパティは省略可能です。何も指定しなければ、現在時刻で公開チェックインをおこないます。
{ }{- "id": 0,
- "checked_in_at": "2020-07-21T19:19:19+0900",
- "tags": [
- "Example",
- "Example_2"
], - "note": "すごく出た",
- "is_private": false,
- "is_too_sensitive": false,
- "discard_elapsed_time": false,
- "source": "api"
}{- "id": 0,
- "checked_in_at": "2020-07-21T19:19:19+0900",
- "tags": [
- "Example",
- "Example_2"
], - "note": "すごく出た",
- "is_private": false,
- "is_too_sensitive": false,
- "discard_elapsed_time": false,
- "source": "api"
}指定したIDのチェックインの情報を編集します。 リクエスト内の項目は全て省略可能であり、更新したい項目のみを送信することができます。
| id required | integer <int64> チェックインID |
| checked_in_at | string <date-time> チェックイン日時 |
| tags | Array of strings[ items <= 255 characters ] タグ |
| link | string <= 2000 characters オカズリンク (http, https) |
| note | string <= 500 characters ノート |
| is_private | boolean 非公開チェックインとして設定 |
| is_too_sensitive | boolean チェックイン対象のオカズをより過激なオカズとして設定 |
| discard_elapsed_time | boolean 前回チェックインからの経過時間を記録しない |
{- "checked_in_at": "2020-07-21T19:19:19+0900",
- "tags": [
- "Example",
- "Example_2"
], - "note": "すごく出た",
- "is_private": true,
- "is_too_sensitive": true,
- "discard_elapsed_time": true
}{- "id": 0,
- "checked_in_at": "2020-07-21T19:19:19+0900",
- "tags": [
- "Example",
- "Example_2"
], - "note": "すごく出た",
- "is_private": false,
- "is_too_sensitive": false,
- "discard_elapsed_time": false,
- "source": "api"
}新規コレクションを作成します。
| title required | string <= 255 characters コレクションのタイトル |
| is_private required | boolean 非公開コレクションとして設定 |
{- "title": "My collection",
- "is_private": false
}{- "id": 0,
- "title": "My collection",
- "is_private": false
}指定したIDのコレクションの情報を編集します。
| collection_id required | integer <int64> コレクションID |
| title required | string <= 255 characters コレクションのタイトル |
| is_private required | boolean 非公開コレクションとして設定 |
{- "title": "My collection",
- "is_private": false
}{- "id": 0,
- "title": "My collection",
- "is_private": false
}指定したコレクションに含まれるアイテムの一覧を取得します。
| collection_id required | integer <int64> コレクションID |
| page | integer Default: 1 ページ番号 |
| per_page | integer [ 10 .. 100 ] Default: 20 1ページあたりのアイテム数 |
[- {
- "id": 0,
- "collection_id": 0,
- "note": "すごく抜ける",
- "tags": [
- "Example",
- "Example_2"
]
}
]指定したコレクションに新しいアイテムを追加します。
| collection_id required | integer <int64> コレクションID |
| link required | string <= 2000 characters オカズリンク (http, https) |
| note | string <= 500 characters ノート |
| tags | Array of strings <= 40 items [ items <= 255 characters ] タグ |
{- "note": "すごく抜ける",
- "tags": [
- "Example",
- "Example_2"
]
}{- "id": 0,
- "collection_id": 0,
- "note": "すごく抜ける",
- "tags": [
- "Example",
- "Example_2"
]
}指定したIDのコレクションアイテムの情報を更新します。 リクエスト内の項目は全て省略可能であり、更新したい項目のみを送信することができます。
| collection_id required | integer <int64> コレクションID |
| collection_item_id required | integer <int64> コレクションアイテムID |
| note | string <= 500 characters ノート |
| tags | Array of strings <= 40 items [ items <= 255 characters ] タグ |
{- "note": "すごく抜ける",
- "tags": [
- "Example",
- "Example_2"
]
}{- "id": 0,
- "collection_id": 0,
- "note": "すごく抜ける",
- "tags": [
- "Example",
- "Example_2"
]
}指定したユーザーのチェックイン数を日毎に合計した情報を取得します。
| name required | string ユーザー名 |
| since | string <date> Example: since=2020-07-21 集計範囲の開始日 |
| until | string <date> Example: until=2021-07-21 集計範囲の終了日 |
[- {
- "date": "2020-07-21",
- "count": 0
}
]指定したユーザーが期間内に最も使用したオカズの上位10件を取得します。
負荷を抑えるため、集計範囲を最大1年分に制限しています。
since のみを指定した場合はその日から1年分、until のみを指定した場合はその日までの1年分を集計します。
両方指定した場合で1年以上の範囲を指定すると since から1年分までに制限して集計します。
どちらも指定しなかった場合は、今年1年分のデータを集計します。
| name required | string ユーザー名 |
| since | string <date> Example: since=2020-07-21 集計範囲の開始日 |
| until | string <date> Example: until=2021-07-21 集計範囲の終了日 |
[
]