API docs by Redocly

Tissue API (2023.12.3)

Download OpenAPI specification:Download

夜のライフログサービス Tissue の公開API仕様です。 全てのAPIのURLは https://shikorism.net/api から始まります。

一部APIではドキュメントに無いプロパティを応答する場合がありますが、これは正式な仕様ではありません。 予告なく削除する可能性がありますので使用しないでください。

webhook

Incoming Webhookに関する仕様

チェックイン

Webhook IDを発行したユーザで新規チェックインを行います。

path Parameters
id
required
string

Webhook管理ページで発行したID

Request Body schema: application/json
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

前回チェックインからの経過時間を記録しない

Responses

Request samples

Content type
application/json
Example

何も指定しなければ、現在時刻で公開チェックインをおこないます。

{ }

Response samples

Content type
application/json
{
  • "status": 200,
  • "checkin": {
    }
}

users

ユーザー情報に関する操作

自分のユーザー情報の取得

自分自身のユーザー情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "string",
  • "is_protected": true,
  • "private_likes": true,
  • "bio": "string",
  • "url": "http://example.com",
  • "checkin_summary": {
    }
}

ユーザー情報の取得

指定したユーザーの情報を取得します。

path Parameters
name
required
string

ユーザー名

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "string",
  • "is_protected": true,
  • "private_likes": true,
  • "bio": "string",
  • "url": "http://example.com",
  • "checkin_summary": {
    }
}

チェックイン一覧の取得

指定したユーザーのチェックイン一覧を取得します。

path Parameters
name
required
string

ユーザー名

query Parameters
page
integer
Default: 1

ページ番号

per_page
integer [ 10 .. 100 ]
Default: 20

1ページあたりのアイテム数

has_link
boolean
Default: false

オカズリンクを含むチェックインのみ取得

Responses

Response samples

Content type
application/json
[
  • {
    }
]

コレクション一覧の取得

指定したユーザーのコレクション一覧を取得します。

path Parameters
name
required
string

ユーザー名

query Parameters
page
integer
Default: 1

ページ番号

per_page
integer [ 10 .. 100 ]
Default: 20

1ページあたりのアイテム数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

checkin

チェックインに関する操作

チェックインの作成

新規チェックインを行います。

Request Body schema: application/json
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

前回チェックインからの経過時間を記録しない

Responses

Request samples

Content type
application/json
Example

全てのプロパティは省略可能です。何も指定しなければ、現在時刻で公開チェックインをおこないます。

{ }

Response samples

Content type
application/json
{
  • "id": 0,
  • "checked_in_at": "2020-07-21T19:19:19+0900",
  • "tags": [
    ],
  • "link": "http://example.com",
  • "note": "すごく出た",
  • "is_private": false,
  • "is_too_sensitive": false,
  • "discard_elapsed_time": false,
  • "source": "api"
}

チェックインの取得

指定したIDのチェックインの情報を取得します。

path Parameters
id
required
integer <int64>

チェックインID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "checked_in_at": "2020-07-21T19:19:19+0900",
  • "tags": [
    ],
  • "link": "http://example.com",
  • "note": "すごく出た",
  • "is_private": false,
  • "is_too_sensitive": false,
  • "discard_elapsed_time": false,
  • "source": "api"
}

チェックインの編集

指定したIDのチェックインの情報を編集します。 リクエスト内の項目は全て省略可能であり、更新したい項目のみを送信することができます。

path Parameters
id
required
integer <int64>

チェックインID

Request Body schema: application/json
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

前回チェックインからの経過時間を記録しない

Responses

Request samples

Content type
application/json
{
  • "checked_in_at": "2020-07-21T19:19:19+0900",
  • "tags": [
    ],
  • "link": "http://example.com",
  • "note": "すごく出た",
  • "is_private": true,
  • "is_too_sensitive": true,
  • "discard_elapsed_time": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "checked_in_at": "2020-07-21T19:19:19+0900",
  • "tags": [
    ],
  • "link": "http://example.com",
  • "note": "すごく出た",
  • "is_private": false,
  • "is_too_sensitive": false,
  • "discard_elapsed_time": false,
  • "source": "api"
}

チェックインの削除

指定したIDのチェックインを削除します。

path Parameters
id
required
integer <int64>

チェックインID

Responses

collection

コレクションに関する操作

コレクションの作成

新規コレクションを作成します。

Request Body schema: application/json
title
required
string <= 255 characters

コレクションのタイトル

is_private
required
boolean

非公開コレクションとして設定

Responses

Request samples

Content type
application/json
{
  • "title": "My collection",
  • "is_private": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "My collection",
  • "is_private": false
}

コレクションの取得

指定したIDのコレクションの情報を取得します。

path Parameters
collection_id
required
integer <int64>

コレクションID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "My collection",
  • "is_private": false
}

コレクションの編集

指定したIDのコレクションの情報を編集します。

path Parameters
collection_id
required
integer <int64>

コレクションID

Request Body schema: application/json
title
required
string <= 255 characters

コレクションのタイトル

is_private
required
boolean

非公開コレクションとして設定

Responses

Request samples

Content type
application/json
{
  • "title": "My collection",
  • "is_private": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "My collection",
  • "is_private": false
}

コレクションの削除

指定したIDのコレクションを削除します。

注意

実装上の都合で、Checkin APIと異なり応答がべき等ではありません。既に削除されている場合は404エラーになりますので、ご注意ください。

path Parameters
collection_id
required
integer <int64>

コレクションID

Responses

コレクション内アイテム一覧の取得

指定したコレクションに含まれるアイテムの一覧を取得します。

path Parameters
collection_id
required
integer <int64>

コレクションID

query Parameters
page
integer
Default: 1

ページ番号

per_page
integer [ 10 .. 100 ]
Default: 20

1ページあたりのアイテム数

Responses

Response samples

Content type
application/json
[
  • {
    }
]

コレクションにアイテムを追加

指定したコレクションに新しいアイテムを追加します。

path Parameters
collection_id
required
integer <int64>

コレクションID

Request Body schema: application/json
link
required
string <= 2000 characters

オカズリンク (http, https)

note
string <= 500 characters

ノート

tags
Array of strings <= 40 items [ items <= 255 characters ]

タグ

Responses

Request samples

Content type
application/json
{
  • "note": "すごく抜ける",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "collection_id": 0,
  • "link": "http://example.com",
  • "note": "すごく抜ける",
  • "tags": [
    ]
}

コレクションアイテムの更新

指定したIDのコレクションアイテムの情報を更新します。 リクエスト内の項目は全て省略可能であり、更新したい項目のみを送信することができます。

path Parameters
collection_id
required
integer <int64>

コレクションID

collection_item_id
required
integer <int64>

コレクションアイテムID

Request Body schema: application/json
note
string <= 500 characters

ノート

tags
Array of strings <= 40 items [ items <= 255 characters ]

タグ

Responses

Request samples

Content type
application/json
{
  • "note": "すごく抜ける",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "collection_id": 0,
  • "link": "http://example.com",
  • "note": "すごく抜ける",
  • "tags": [
    ]
}

コレクションからアイテムを削除

コレクションから、指定したIDのコレクションアイテムを削除します。

注意

実装上の都合で、Checkin APIと異なり応答がべき等ではありません。既に削除されている場合は404エラーになりますので、ご注意ください。

path Parameters
collection_id
required
integer <int64>

コレクションID

collection_item_id
required
integer <int64>

コレクションアイテムID

Responses

user-stats

ユーザーの統計情報

日毎のチェックイン数

指定したユーザーのチェックイン数を日毎に合計した情報を取得します。

path Parameters
name
required
string

ユーザー名

query Parameters
since
string <date>
Example: since=2020-07-21

集計範囲の開始日

until
string <date>
Example: until=2021-07-21

集計範囲の終了日

Responses

Response samples

Content type
application/json
[
  • {
    }
]

時間毎のチェックイン数

指定したユーザーのチェックイン数を時間毎に合計した情報を取得します。

path Parameters
name
required
string

ユーザー名

query Parameters
since
string <date>
Example: since=2020-07-21

集計範囲の開始日

until
string <date>
Example: until=2021-07-21

集計範囲の終了日

Responses

Response samples

Content type
application/json
[
  • {
    }
]

最も使用したタグ

指定したユーザーが期間内に最も使用したタグの上位10件を取得します。

path Parameters
name
required
string

ユーザー名

query Parameters
since
string <date>
Example: since=2020-07-21

集計範囲の開始日

until
string <date>
Example: until=2021-07-21

集計範囲の終了日

Responses

Response samples

Content type
application/json
[
  • {
    }
]

最も使用したオカズ

指定したユーザーが期間内に最も使用したオカズの上位10件を取得します。

範囲指定について

負荷を抑えるため、集計範囲を最大1年分に制限しています。

since のみを指定した場合はその日から1年分、until のみを指定した場合はその日までの1年分を集計します。

両方指定した場合で1年以上の範囲を指定すると since から1年分までに制限して集計します。

どちらも指定しなかった場合は、今年1年分のデータを集計します。

path Parameters
name
required
string

ユーザー名

query Parameters
since
string <date>
Example: since=2020-07-21

集計範囲の開始日

until
string <date>
Example: until=2021-07-21

集計範囲の終了日

Responses

Response samples

Content type
application/json
[]