Memoreru

APIの概要

Memoreru
先週
0

Memoreru API

Memoreru APIを使うと、外部のアプリケーションやスクリプトからMemoreruのデータにアクセスできます。

APIでできること

  • コンテンツの作成・取得・更新・削除: ページ、テーブル、スライド、フォルダなどをプログラムから操作
  • テーブル行の操作: 行データの取得・追加・更新・削除（1件でも複数件でも同じエンドポイント）
  • テーブル列の操作: 列の定義の取得・作成・更新・削除

APIドキュメント

すべてのエンドポイントの詳細仕様はAPIドキュメントで確認できます。リクエスト/レスポンスの形式、パラメータの説明、実際にAPIを試すこともできます。

APIドキュメントを開く →

利用条件

Memoreru APIはライトプラン以上でご利用いただけます。機能トライアル期間中も利用できます。

プランAPIリクエスト数/月
フリー利用不可
トライアル1,000回
ライト1,000回
スタンダード5,000回
ビジネス50,000回

認証方式

APIの認証にはAPIキーを使用します。APIキーの発行方法は「APIキーの管理」をご参照ください。

Authorization: Bearer mk_xxxxxxxxxxxx

ベースURL

https://memoreru.com/api/v1/

エンドポイント一覧

コンテンツ共通

操作メソッドエンドポイント
コンテンツ一覧の取得GET/contents

取得・更新・削除は、下のタイプ別のエンドポイントを使います（例: ページなら /contents/pages/{contentId}）。
タイプの違う ID を指定した場合は「見つかりません」として扱われます。

フォルダ

操作メソッドエンドポイント
フォルダの作成POST/contents/folders
フォルダの取得GET/contents/folders/{contentId}
フォルダの更新PATCH/contents/folders/{contentId}
フォルダの削除DELETE/contents/folders/{contentId}

ページ

操作メソッドエンドポイント
ページの作成POST/contents/pages
ページの取得GET/contents/pages/{contentId}
ページの更新PATCH/contents/pages/{contentId}
ページの削除DELETE/contents/pages/{contentId}

テーブル

操作メソッドエンドポイント
テーブルの作成POST/contents/tables
テーブルの取得GET/contents/tables/{contentId}
テーブルの更新PATCH/contents/tables/{contentId}
テーブルの削除DELETE/contents/tables/{contentId}
テーブル列の作成POST/contents/tables/{contentId}/columns
テーブル列の取得GET/contents/tables/{contentId}/columns
テーブル列の更新PATCH/contents/tables/{contentId}/columns
テーブル列の削除DELETE/contents/tables/{contentId}/columns
テーブル行の作成POST/contents/tables/{contentId}/rows
テーブル行の取得GET/api/v1/contents/tables/{tableId}/rows?cursor&limit
テーブル行の更新PATCH/contents/tables/{contentId}/rows
テーブル行の削除DELETE/contents/tables/{contentId}/rows
テーブル行数の取得GET/contents/tables/{contentId}/rows/count
テーブル行の作成・更新POST/contents/tables/{contentId}/rows/upsert

スライド

操作メソッドエンドポイント
スライドの作成POST/contents/slides
スライドの取得GET/contents/slides/{contentId}
スライドの更新PATCH/contents/slides/{contentId}
スライドの削除DELETE/contents/slides/{contentId}

ビュー

操作メソッドエンドポイント
ビューの作成POST/contents/views
ビューの取得GET/contents/views/{contentId}
ビューの更新PATCH/contents/views/{contentId}
ビューの削除DELETE/contents/views/{contentId}

グラフ

操作メソッドエンドポイント
グラフの作成POST/contents/graphs
グラフの取得GET/contents/graphs/{contentId}
グラフの更新PATCH/contents/graphs/{contentId}
グラフの削除DELETE/contents/graphs/{contentId}

ダッシュボード

操作メソッドエンドポイント
ダッシュボードの作成POST/contents/dashboards
ダッシュボードの取得GET/contents/dashboards/{contentId}
ダッシュボードの更新PATCH/contents/dashboards/{contentId}
ダッシュボードの削除DELETE/contents/dashboards/{contentId}

画面

操作メソッドエンドポイント
画面の作成POST/contents/screens
画面の取得GET/contents/screens/{contentId}
画面の更新PATCH/contents/screens/{contentId}
画面の削除DELETE/contents/screens/{contentId}

帳票

操作メソッドエンドポイント
帳票の作成POST/contents/reports
帳票の取得GET/contents/reports/{contentId}
帳票の更新PATCH/contents/reports/{contentId}
帳票の削除DELETE/contents/reports/{contentId}

ワークフロー

操作メソッドエンドポイント
ワークフローの作成POST/contents/workflows
ワークフローの取得GET/contents/workflows/{contentId}
ワークフローの更新PATCH/contents/workflows/{contentId}
ワークフローの削除DELETE/contents/workflows/{contentId}

パスワード保護

操作メソッドエンドポイント
コンテンツパスワードの設定/更新PUT/contents/{contentId}/password
コンテンツパスワードの削除DELETE/contents/{contentId}/password
コンテンツパスワードの検証POST/contents/{contentId}/password/verify
パスワードヒントの取得GET/contents/{contentId}/password/hint

Webhook

操作メソッドエンドポイント
Webhook の一覧取得GET/contents/{contentId}/webhooks
Webhook の作成POST/contents/{contentId}/webhooks
Webhook の更新PATCH/contents/{contentId}/webhooks/{webhookId}
Webhook の削除DELETE/contents/{contentId}/webhooks/{webhookId}
Webhook 配信ログの取得GET/contents/{contentId}/webhooks/{webhookId}/deliveries
Webhook のテスト送信POST/contents/{contentId}/webhooks/{webhookId}/test

拡張設定

操作メソッドエンドポイント
拡張設定の一覧取得GET/contents/{contentId}/extensions
拡張設定の作成POST/contents/{contentId}/extensions
拡張設定の更新PATCH/contents/{contentId}/extensions/{extensionId}
拡張設定の削除DELETE/contents/{contentId}/extensions/{extensionId}
拡張設定の実行ログ取得GET/contents/{contentId}/extensions/{extensionId}/logs
アクティブなスタイルの取得GET/contents/{contentId}/extensions/styles/active

すべてのエンドポイントの詳細はAPIドキュメントをご確認ください。

レスポンスの形式

  • 成功時は { "status": "success", "data": ... } の形で返ります。テーブル行一覧（GET /api/v1/contents/tables/{tableId}/rows?cursor&limit）では、limit に取得する行数を指定します。最初のリクエストでは cursor を省略し、応答の pagination（limit / hasMore / nextCursor）を確認します
  • 続きがある場合は hasMore が true になり、返された nextCursor を次のリクエストの cursor に指定します。hasMore が false で nextCursor が null なら、一覧は終わりです
  • 失敗時は application/problem+json 形式で、原因を表す code が入ります。code の一覧は APIドキュメント の末尾「Errors」に掲載しています

レート制限

APIにはエンドポイントごとのレート制限が設けられています。デフォルトは60リクエスト/分です。

制限を超えた場合は 429 Too Many Requests レスポンスが返されます。レスポンスヘッダーの X-RateLimit-Remaining と Retry-After で残り回数と待ち時間を確認できます。

スコープ

APIキーにはスコープ（権限範囲）を設定できます:

  • 読み取り+書き込み: すべての操作が可能（GET, POST, PATCH, DELETE）
  • 読み取り専用: データの取得のみ可能（GET）

書き込み操作（POST, PATCH, DELETE）を読み取り専用キーで実行すると、403 INSUFFICIENT_SCOPE エラーが返されます。

コメント

0
0
0