【タイッツー】最初期版APIの使い方
公開 2023/07/22 00:31
最終更新
2024/06/04 14:51
現時点では、認証不要の参照系APIのみの公開となります。
認証APIについては最初期版APIに追って追加される可能性がありますが、正式版APIまで追加されない可能性もあります。
(すみません、ちょっとまだ未定です…💦)
APIキーを発行いたしますので、以下の記事のフォームからご入力をお願いいたします。
https://hoku.fanbox.cc/posts/6384440
API利用を希望で入力したにも関わらずPIXIV上のDMで連絡が来ていない場合、以下ご確認をお願いいたします。
①「サポータープラス」プランではないか?(API早期アクセスは「サポータープラスプラス」以上となります。)
②PIXIVのユーザーID入力をちゃんと数値で入れたか?(怪しい場合は、再度フォームにご入力をお願いいたします。)
③「①」も「②」も問題ないのにDMが来ていない場合は、お手数ですが私(hoku)宛にPIXIVのDMをいただけますでしょうか。
★人を不快にさせるような利用方法は不可。(例えば、特定の人を探して晒し上げて笑いものにするためのツール!とかNG。そんなの作る人いないとは思いますが、一応…。)
★その他一般常識として問題のない範囲でご利用ください。
★データをキャッシュしてそのまま表示に使用する場合、キャッシュ期間は最大5分までとしてください。(タイーツ等を解析してその集計結果等を公開するサイトであれば、期限に制限はありません。例えば、1日毎のつぶやかれたワードランキング、等。)
★本バージョンのAPIは、正式版APIが出た後に廃止となる予定です。ご了承ください。
★いわば正式版までのつなぎ版で、I/Fが結構イケていない感じもありますが、一旦これでご利用ください🙇
★広告の扱いについて、後述のルールを守ってください。
(パブリックタイムライン取得、タイーツ一覧取得、のAPIにおいて、取得したタイーツ一覧内に広告タイーツが含まれます。その広告タイーツに対する扱いのルールです。)
★取得したタイーツ一覧を画面上に表示して使用する用途の場合、いかなる場合でも広告タイーツを除外してはいけません。
★広告タイーツの表示を目立たなくさせる、目立たせすぎる、といった表示も不可。[AD]や[広告]や[プロモーション]といった言葉を添えて他のタイーツと共に必ず表示させること。
★広告タイーツ内のURLは必ずリンクさせ、ワンタップでサイトに遷移するように実装すること。
★例外として、タイーツの情報をもとにデータ集計を行ったり統計を取るなどして、その結果のみを表示に用いる場合においては、広告タイーツを除外して処理を行って良いものとする。(例えば、1日毎のつぶやかれたワードランキング、等。)(このパターンの場合、将来的に利用量に応じて有料プランとなる可能性があります。少なくとも現時点では追加課金無しで大丈夫です。)
★広告タイーツか否かの判定は、タイーツ情報内に「is_ad」という項目が存在し、それがtrueのものが広告タイーツである。
★フォロー/フォロワー情報の取得など、「ユーザー情報」の取得時には広告が入りませんので気にしなくて大丈夫です。
ほかは全て固定値または最初期版では気にしなくて良い値。
特に、「user_id(ユーザー内部ID)」は使うっぽい雰囲気だが、使わない。
レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
項目名がパブリックタイムライン取得のときと違いますが、目をつぶっていただいて…🙇
レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
この場合、「.thumb.jpg」をくっつけたURLがサムネイルになります。
→例:「~~~/playlist.m3u8.thumb.jpg」
メディアのURLが「~~~/~~~_animation.gif」はアニメーションGIFで、これも「.thumb.jpg」をくっつけるとサムネになります。
→例:「~~~/~~~_animation.gif.thumb.jpg」
(※「_animation」がつかない.gifの場合、これはアニメじゃない普通のGIFなのでサムネもありません。)
認証APIについては最初期版APIに追って追加される可能性がありますが、正式版APIまで追加されない可能性もあります。
(すみません、ちょっとまだ未定です…💦)
目次
■最初期版APIの利用方法 #
PIXIV FANBOXの「サポータープラスプラス」プラン以上にてご支援いただいている方向けに、最初期版APIの早期アクセスをご提供しております。APIキーを発行いたしますので、以下の記事のフォームからご入力をお願いいたします。
https://hoku.fanbox.cc/posts/6384440
API利用を希望で入力したにも関わらずPIXIV上のDMで連絡が来ていない場合、以下ご確認をお願いいたします。
①「サポータープラス」プランではないか?(API早期アクセスは「サポータープラスプラス」以上となります。)
②PIXIVのユーザーID入力をちゃんと数値で入れたか?(怪しい場合は、再度フォームにご入力をお願いいたします。)
③「①」も「②」も問題ないのにDMが来ていない場合は、お手数ですが私(hoku)宛にPIXIVのDMをいただけますでしょうか。
■最初期版APIの使用上のルール #
★1秒間に何十回もアクセスするような高頻度のアクセスは不可。★人を不快にさせるような利用方法は不可。(例えば、特定の人を探して晒し上げて笑いものにするためのツール!とかNG。そんなの作る人いないとは思いますが、一応…。)
★その他一般常識として問題のない範囲でご利用ください。
★データをキャッシュしてそのまま表示に使用する場合、キャッシュ期間は最大5分までとしてください。(タイーツ等を解析してその集計結果等を公開するサイトであれば、期限に制限はありません。例えば、1日毎のつぶやかれたワードランキング、等。)
★本バージョンのAPIは、正式版APIが出た後に廃止となる予定です。ご了承ください。
★いわば正式版までのつなぎ版で、I/Fが結構イケていない感じもありますが、一旦これでご利用ください🙇
★広告の扱いについて、後述のルールを守ってください。
■タイーツ一覧内に含まれる広告について #
現実的に持続可能なAPIの運用方法を模索しておりまして、現時点においては以下のルールとさせていただきます。今後変更となる可能性は十分にあります。(パブリックタイムライン取得、タイーツ一覧取得、のAPIにおいて、取得したタイーツ一覧内に広告タイーツが含まれます。その広告タイーツに対する扱いのルールです。)
★取得したタイーツ一覧を画面上に表示して使用する用途の場合、いかなる場合でも広告タイーツを除外してはいけません。
★広告タイーツの表示を目立たなくさせる、目立たせすぎる、といった表示も不可。[AD]や[広告]や[プロモーション]といった言葉を添えて他のタイーツと共に必ず表示させること。
★広告タイーツ内のURLは必ずリンクさせ、ワンタップでサイトに遷移するように実装すること。
★例外として、タイーツの情報をもとにデータ集計を行ったり統計を取るなどして、その結果のみを表示に用いる場合においては、広告タイーツを除外して処理を行って良いものとする。(例えば、1日毎のつぶやかれたワードランキング、等。)(このパターンの場合、将来的に利用量に応じて有料プランとなる可能性があります。少なくとも現時点では追加課金無しで大丈夫です。)
★広告タイーツか否かの判定は、タイーツ情報内に「is_ad」という項目が存在し、それがtrueのものが広告タイーツである。
★フォロー/フォロワー情報の取得など、「ユーザー情報」の取得時には広告が入りませんので気にしなくて大丈夫です。
■パブリックタイムライン取得 #
リクエスト #
# 初回
curl https://publicapi.taittsuu.com/publicapi/v0.1/publictimelines \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
# 続きを取得
curl https://publicapi.taittsuu.com/publicapi/v0.1/publictimelines \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d next=48
レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。レスポンス #
{
"data": [
{
"id": 1455806,
"user_id": 1,
"content": "タイーツ本文タイーツ本文タイーツ本文タイーツ本文",
"post_type": 10,
"is_defensive": 0,
"is_sensitive": 0,
"scope": 10,
"exist_media": 0,
"exist_url": 0,
"exist_hashtag": 0,
"target_rt_post_id": null,
"created_at": "2023-01-01T00:00:00.000000Z",
"user_name": "ほく",
"user_screenname": "hoku",
"is_verified": 1,
"is_locked": 0,
"like_count": 0,
"rt_count": 0,
"is_liked": false,
"is_retaiitsued": false,
"is_ignored": false,
"is_ad":false,
"ad_id":1
},
{
…
}
],
"next": 1234
}
現時点で気にすべき値は「id(タイーツID)」「content(タイーツ本文)」「created_at(投稿日時)」「user_name(ユーザー名)」「user_screenname(ユーザーID)」「is_verified(認証状態)」「like_count(いいね数)」「rt_count(RT数)」「is_ad(広告か否か)」のみ。ほかは全て固定値または最初期版では気にしなくて良い値。
特に、「user_id(ユーザー内部ID)」は使うっぽい雰囲気だが、使わない。
■タイーツ一覧取得 #
リクエスト #
# 初回
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID}/taiitsus \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
# 続きを取得
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID}/taiitsus \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d next=75
URLに{ユーザーID}を含めてください。(ユーザー内部IDではないです)レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンス #
パブリックタイムライン取得と同じフォーマット。
■タイーツ取得 #
リクエスト #
curl https://publicapi.taittsuu.com/publicapi/v0.1/taiitsus/{タイーツID} \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
URLに{タイーツID}を含めてください。レスポンス #
パブリックタイムライン取得と同じフォーマット。
ただし、1件の配列である。
また、[next]項目は含まれない。
■いいねしたユーザー一覧取得 #
リクエスト #
# 初回
curl https://publicapi.taittsuu.com/publicapi/v0.1/taiitsus/{タイーツID}/liking_users \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
# 続きを取得
curl https://publicapi.taittsuu.com/publicapi/v0.1/taiitsus/{タイーツID}/liking_users \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d next=33
URLに{タイーツID}を含めてください。レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンス #
{
"data": [
{
"post_like_id": 1,
"id": 1,
"name": "ほく",
"is_verified": 1,
"is_locked": 0,
"screen_name": "hoku",
"started_at": "2023-07-20 19:15:46",
"bio": "こんちは"
},
{
…
}
],
"next": 1234
}
現時点で気にすべき値は「name(ユーザー名)」「is_verified(認証状態)」「is_locked(鍵アカ状態)」「screen_name(ユーザーID)」「started_at(タイッツー開始日時)」「bio(自己紹介)」のみ。項目名がパブリックタイムライン取得のときと違いますが、目をつぶっていただいて…🙇
■ユーザー取得 #
リクエスト #
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID} \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
URLに{ユーザーID}を含めてください。レスポンス #
{
"data": {
"id": 1,
"screen_name": "hoku",
"name": "ほく",
"bio": "こんちは",
"image_path": null,
"url": "http://hoku.in/",
"started_at": "2023-07-01T00:00:00.000000Z",
"is_locked": 0,
"is_verified": 1
}
}
配列ではなくオブジェクトで返ります。■フォロー取得 #
リクエスト #
# 初回
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID}/following \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
# 続きを取得
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID}/following \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d next=24
URLに{ユーザーID}を含めてください。レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンス #
{
"data": [
{
"id": 1,
"name": "ほく",
"is_verified": 1,
"is_locked": 0,
"screen_name": "hoku",
"started_at": "2023-07-01T00:00:00.000000Z",
"bio": "こんちは",
"user_follow_id": 1234
},
{
…
}
],
"next": 1234
}
現時点で「id(ユーザー内部名)」「user_follow_id(フォロー内部ID)」は気にしなくてOKな値。■フォロワー取得 #
リクエスト #
# 初回
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID}/followers \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key"
# 続きを取得
curl https://publicapi.taittsuu.com/publicapi/v0.1/users/{ユーザーID}/followers \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d next=24
URLに{ユーザーID}を含めてください。レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンス #
フォロー取得と同じ。
■ユーザー検索 #
リクエスト #
# 初回
curl https://publicapi.taittsuu.com/publicapi/v0.1/search/users \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d query=開発用
# 続きを取得
curl https://publicapi.taittsuu.com/publicapi/v0.1/search/users \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key" \
-G -d "query=開発用&next=12"
queryに検索ワードを入れてください。(複数ワードには対応していません)レスポンスにnextが入っている場合、その値をリクエストに含めることで続きを取得できます。
レスポンス #
{
"data": [
{
"id": 2,
"name": "ほく(開発用)",
"is_verified": 1,
"screen_name": "hoku_dev",
"started_at": "2023-07-01T00:00:00.000000Z",
"bio": "開発用のアカウント。",
"is_locked": 1
},
{
…
}
],
"next": 1234
}
現時点で「id(ユーザー内部名)」は気にしなくてOKな値。■メディアファイルについて #
動画の場合はメディアのURLが「~~~/playlist.m3u8」になっています。この場合、「.thumb.jpg」をくっつけたURLがサムネイルになります。
→例:「~~~/playlist.m3u8.thumb.jpg」
メディアのURLが「~~~/~~~_animation.gif」はアニメーションGIFで、これも「.thumb.jpg」をくっつけるとサムネになります。
→例:「~~~/~~~_animation.gif.thumb.jpg」
(※「_animation」がつかない.gifの場合、これはアニメじゃない普通のGIFなのでサムネもありません。)
シンプルブログの運営者です。
色々作ってます。タイッツーも運営しています。
https://taittsuu.com/
よろしくお願いします〜🙇✨
色々作ってます。タイッツーも運営しています。
https://taittsuu.com/
よろしくお願いします〜🙇✨
最近の記事
タグ