Memoreru

APIの概要

Memoreru
yesterday
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
コンテンツ件数の取得GET/contents/count

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

フォルダ

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

ページ

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

テーブル

操作メソッドエンドポイント
テーブルの作成POST/contents/tables
テーブルの取得GET/contents/tables/:table_id
テーブルの更新PATCH/contents/tables/:table_id
テーブルの削除DELETE/contents/tables/:table_id
テーブル列の作成POST/contents/tables/:table_id/columns
テーブル列の取得GET/contents/tables/:table_id/columns
テーブル列の更新PATCH/contents/tables/:table_id/columns
テーブル列の削除DELETE/contents/tables/:table_id/columns
テーブル行の作成POST/contents/tables/:table_id/rows
テーブル行の取得GET/contents/tables/:table_id/rows
テーブル行の更新PATCH/contents/tables/:table_id/rows
テーブル行の削除DELETE/contents/tables/:table_id/rows
テーブル行数の取得GET/contents/tables/:table_id/rows/count
テーブル行の作成・更新POST/contents/tables/:table_id/rows/upsert

スライド

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

ビュー

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

グラフ

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

ダッシュボード

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

画面

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

帳票

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

ワークフロー

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

パスワード保護

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

Webhook

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

拡張設定

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

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

レスポンスの形式

  • 成功時は { "status": "success", "data": ... } の形で返ります。一覧の取得では pagination(page / limit / total / has_more)が付きます
  • ページの指定はどのエンドポイントでも page(1 始まり)と limit です
  • 失敗時は 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 エラーが返されます。

Comments

0
0
0