NotePM API ドキュメント

概要

NotePM API について仕様を説明します。

NotePM APIはβ公開となります。
不具合や機能追加のご要望など承っておりますので、お問い合わせフォームよりお気軽にご連絡ください!

ホスト プロトコル バージョン データ形式
notepm.jp https v1 JSON

URL
https://{チームドメイン}.notepm.jp/api/v1
例) https://demo.notepm.jp/api/v1

アクセストークン

全てのAPIリクエストにNotePM内で取得したAPIアクセストークンを Authorizationリクエストヘッダに付与してください。

Authorization: Bearer dAu9ceALVbaD6DbApXaAs2y0LRVVLae5rn0Ll9UiV6wtMOBf5thOm6yvPLTTZGbK
Copy

APIアクセストークン作成方法

  • アクセストークンはオーナーまたは管理者権限のユーザーのみ作成することができます。
  • 権限変更でユーザー権限等に変更された場合、そのユーザーが作成したアクセストークンは全て使用できなくなります。

個人設定の「アクセストークン」から「新規作成」ボタンをクリックします。

トークン名、スコープ範囲の選択をして「新規作成」ボタンをクリックします。

項目 内容
トークン名 トークンの目的がわかる名前を入力してください。
例)一括インポート用
スコープ APIトークンのアクセス権の範囲を選択します。

APIアクセストークンが表示されます。
表示されているアクセストークンを控えた後、「閉じる」をクリックします。

ステータスコード

下記のコードを返却します。

ステータスコード 説明
200 リクエスト成功
201 登録成功
204 リクエストに成功したが返却するbodyが存在しない
400 不正なリクエストパラメータを指定している
401 APIアクセストークンが不正、または権限不正
404 存在しないURLにアクセス
429 リクエスト制限を超えている
500 不明なエラー

利用制限

ユーザ毎に1分間に60リクエストまで受け付けます。
決められた制限を超える場合は、429 Too Many Requests が返却されます。

チーム

https://notepm.jp/docs/api/team

ユーザー

https://notepm.jp/docs/api/user

ノート

https://notepm.jp/docs/api/note

フォルダ

https://notepm.jp/docs/api/folder

ページ

https://notepm.jp/docs/api/page

コメント

https://notepm.jp/docs/api/comment

添付ファイル

https://notepm.jp/docs/api/attachment

グループ

https://notepm.jp/docs/api/group