戻る English

ウミブドウ APIマニュアル

ウミブドウのAPIは、外部のアプリやツールからAPIキーを使って接続するための仕組みです。このマニュアルでは、APIキーの取得方法と、動作確認用の sayHello、ノートの取得APIの使い方を説明します。

APIキーの取得

APIキーの使い方

APIを呼ぶときは、Authorization ヘッダーに Bearer <キー> の形でキーを付けます。キーをURLやリクエスト本文に含めないでください。

sayHello(動作確認)

APIキーが正しく使えるかを確認するためのAPIです。

呼び出し例(curl):

成功すると、次のようなJSONが返ります。

ノートの一覧を取得する

自分のノートの一覧を取得するAPIです(読み取り専用)。

ノートの内容を取得する

ノートの内容(項目の一覧)を取得するAPIです(読み取り専用)。一覧で取得した id を file_id に指定します。

ノートを作成する

新しいノートを作成するAPIです。作成したノートの file_id を、項目の書き込みにそのまま使えます。

ノートに書き込む

APIキーでノートの項目を作成・更新・削除することもできます。書き込みは POST で、JSONの本文を送ります(file_id は必須です)。

呼び出し例(curl):

APIキーは発行した本人の権限で動くため、キーが漏れるとノートを書き換えられるおそれがあります。書き込みに使わないキーは発行しない、漏れたおそれがあるキーはすぐ削除する、といった管理をお願いします。

エラー

注意