API Document

togetnoteのAPIについてがここに書かれています。

TOKEN

APIを使用するにはユーザーに1つ与えられるTOKEN（token、トークン）を取得、発行する必要があります。 TOKENの発行方法は機能紹介のところで紹介されているので何かわからないことがあればそこをご参照ください。

TOKEN

---

Limitations

togetnoteのAPIには制限があります。

Per day（86400 sec）	50回（リクエスト数）	同じIPアドレスで1日50回のリクエストを送信できます。
Interval time	10秒間	リクエストを送信してからのインターバルです。

この制限が利用者数や環境や状況によって変更される可能性があります。

Error Code

ここにtogetnoteにリクエストを送信したときに帰ってくるエラーの原因などがまとめてあります。

500	何らかの理由によって、その目的を果たすことができなかった
429	同じIPアドレスから、許可されているリクエスト数以上のものを送信しようとした またはインターバルを無視してリクエストしようとした
413	許可されている文字数の制限を超えた
401	提供されたものが正常なもの、正しいものではなかった
400	提供されなきゃいけないものが提供されていなかった

---

note/create

このAPIは以下のURLを使用することで使用可能です。 これを使用すればタイトル、内容をパラメーターから指定し、ノートを追加することができます。

https://tn.piennu777.jp/API/note/create/

必須パラメーター

?token={token}&title={title}&note={note}

サンプル

https://tn.piennu777.jp/API/note/create/?token=000000000000000000000000000000000000000000000000000000000000000000000000000000000000&title=TITLE&note=NOTE

{
    "success": true,
    "title": "TITLE",
    "note": "NOTE",
    "created_at": "2024-10-07 23:08:20",
    "note_id": "00000000000000000000000000000000"
}

note/delete

このAPIは以下のURLを使用することで使用可能です。 これを使用すれば自分のノートをIDを入力ことによって削除することができます。

https://tn.piennu777.jp/API/note/delete/

必須パラメーター

?token={token}&note_id={note_id}

サンプル

https://tn.piennu777.jp/API/note/create/?token=000000000000000000000000000000000000000000000000000000000000000000000000000000000000&note_id=00000000000000000000000000000000

{
    "success": true,
    "note_id": "00000000000000000000000000000000",
    "message": "Note deleted successfully."
}