REST APIリファレンス

EmDashは、コンテンツ管理、メディアアップロード、スキーマ操作のために /_emdash/api/ にREST APIを公開しています。

認証

APIリクエストには、AuthorizationヘッダーにBearerトークンによる認証が必要です:

Authorization: Bearer <token>

トークンは管理インターフェースまたはプログラムで生成できます。

レスポンス形式

すべてのレスポンスは一貫した形式に従います。成功したレスポンスは結果を data でラップします:

{
  "success": true,
  "data": { ... }
}

エラーレスポンスには、コード、メッセージ、オプションの詳細が含まれます:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message",
    "details": { ... }
  }
}

コンテンツエンドポイント

コンテンツを一覧表示

GET /_emdash/api/content/:collection

パラメータ

レスポンス

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "01HXK5MZSN...",
        "type": "posts",
        "slug": "hello-world",
        "data": { "title": "Hello World", ... },
        "status": "published",
        "createdAt": "2025-01-24T12:00:00Z",
        "updatedAt": "2025-01-24T12:00:00Z"
      }
    ],
    "nextCursor": "eyJpZCI6..."
  }
}

コンテンツを取得

GET /_emdash/api/content/:collection/:id

レスポンス

{
  "success": true,
  "data": {
    "item": {
      "id": "01HXK5MZSN...",
      "type": "posts",
      "slug": "hello-world",
      "data": { "title": "Hello World", ... },
      "status": "published",
      "createdAt": "2025-01-24T12:00:00Z",
      "updatedAt": "2025-01-24T12:00:00Z"
    }
  }
}

コンテンツを作成

POST /_emdash/api/content/:collection
Content-Type: application/json

リクエストボディ

{
  "data": {
    "title": "New Post",
    "content": [...]
  },
  "slug": "new-post",
  "status": "draft"
}

レスポンス

{
  "success": true,
  "data": {
    "item": { ... }
  }
}

コンテンツを更新

PUT /_emdash/api/content/:collection/:id
Content-Type: application/json

リクエストボディ

{
	"data": {
		"title": "Updated Title"
	},
	"status": "published"
}

コンテンツを削除

DELETE /_emdash/api/content/:collection/:id

レスポンス

{
	"success": true,
	"data": {
		"success": true
	}
}

メディアエンドポイント

メディアを一覧表示

GET /_emdash/api/media

パラメータ

レスポンス

{
	"success": true,
	"data": {
		"items": [
			{
				"id": "01HXK5MZSN...",
				"filename": "photo.jpg",
				"mimeType": "image/jpeg",
				"size": 102400,
				"width": 1920,
				"height": 1080,
				"url": "https://cdn.example.com/photo.jpg",
				"createdAt": "2025-01-24T12:00:00Z"
			}
		],
		"nextCursor": "eyJpZCI6..."
	}
}

メディアを取得

GET /_emdash/api/media/:id

メディアを作成

POST /_emdash/api/media
Content-Type: application/json

リクエストボディ

{
	"filename": "photo.jpg",
	"mimeType": "image/jpeg",
	"size": 102400,
	"width": 1920,
	"height": 1080,
	"storageKey": "uploads/photo.jpg"
}

メディアを更新

PUT /_emdash/api/media/:id
Content-Type: application/json

リクエストボディ

{
	"alt": "Photo description",
	"caption": "Photo caption"
}

メディアを削除

DELETE /_emdash/api/media/:id

メディアファイルを取得

GET /_emdash/api/media/file/:key

実際のファイルコンテンツを提供します。ローカルストレージのみ対応。

リビジョンエンドポイント

リビジョンを一覧表示

GET /_emdash/api/content/:collection/:entryId/revisions

パラメータ

レスポンス

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "01HXK5MZSN...",
        "collection": "posts",
        "entryId": "01HXK5MZSN...",
        "data": { ... },
        "createdAt": "2025-01-24T12:00:00Z"
      }
    ],
    "total": 5
  }
}

リビジョンを取得

GET /_emdash/api/revisions/:revisionId

リビジョンを復元

POST /_emdash/api/revisions/:revisionId/restore

コンテンツをこのリビジョンの状態に復元し、新しいリビジョンを作成します。

スキーマエンドポイント

コレクションを一覧表示

GET /_emdash/api/schema/collections

レスポンス

{
	"success": true,
	"data": {
		"items": [
			{
				"id": "01HXK5MZSN...",
				"slug": "posts",
				"label": "Posts",
				"labelSingular": "Post",
				"supports": ["drafts", "revisions", "preview"]
			}
		]
	}
}

コレクションを取得

GET /_emdash/api/schema/collections/:slug

パラメータ

コレクションを作成

POST /_emdash/api/schema/collections
Content-Type: application/json

リクエストボディ

{
	"slug": "products",
	"label": "Products",
	"labelSingular": "Product",
	"description": "Product catalog",
	"supports": ["drafts", "revisions"]
}

コレクションを更新

PUT /_emdash/api/schema/collections/:slug
Content-Type: application/json

コレクションを削除

DELETE /_emdash/api/schema/collections/:slug

パラメータ

フィールドを一覧表示

GET /_emdash/api/schema/collections/:slug/fields

フィールドを作成

POST /_emdash/api/schema/collections/:slug/fields
Content-Type: application/json

リクエストボディ

{
	"slug": "price",
	"label": "Price",
	"type": "number",
	"required": true,
	"validation": {
		"min": 0
	}
}

フィールドを更新

PUT /_emdash/api/schema/collections/:collectionSlug/fields/:fieldSlug
Content-Type: application/json

フィールドを削除

DELETE /_emdash/api/schema/collections/:collectionSlug/fields/:fieldSlug

フィールドを並べ替え

POST /_emdash/api/schema/collections/:slug/fields/reorder
Content-Type: application/json

リクエストボディ

{
	"fieldSlugs": ["title", "content", "author", "publishedAt"]
}

スキーマエクスポート

スキーマをエクスポート（JSON）

GET /_emdash/api/schema
Accept: application/json

スキーマをエクスポート（TypeScript）

GET /_emdash/api/schema?format=typescript
Accept: text/typescript

すべてのコレクションのTypeScriptインターフェースを返します。

プラグインエンドポイント

プラグインを一覧表示

GET /_emdash/api/admin/plugins

プラグインを取得

GET /_emdash/api/admin/plugins/:id

プラグインを有効化

POST /_emdash/api/admin/plugins/:id/enable

プラグインを無効化

POST /_emdash/api/admin/plugins/:id/disable

エラーコード

検索エンドポイント

グローバル検索

GET /_emdash/api/search?q=hello+world

パラメータ

レスポンス

{
  "success": true,
  "data": {
    "items": [
      {
        "collection": "posts",
        "id": "01HXK5MZSN...",
        "slug": "hello-world",
        "locale": "en",
        "title": "Hello World",
        "snippet": "...this is a <mark>hello</mark> <mark>world</mark> example...",
        "score": 0.95
      }
    ],
    "nextCursor": "eyJvZmZzZXQiOjIwfQ"
  }
}

検索候補

GET /_emdash/api/search/suggest?q=hel&limit=5

オートコンプリート用のプレフィックスに一致するタイトルを返します。

検索インデックスを再構築

POST /_emdash/api/search/rebuild

すべてのコレクションまたは特定のコレクションのFTSインデックスを再構築します。

検索統計

GET /_emdash/api/search/stats

コレクションごとのインデックス化されたドキュメント数を返します。

セクションエンドポイント

セクションを一覧表示

GET /_emdash/api/sections
GET /_emdash/api/sections?source=theme
GET /_emdash/api/sections?search=newsletter

セクションを取得

GET /_emdash/api/sections/:slug

セクションを作成

POST /_emdash/api/sections
Content-Type: application/json

{
  "slug": "my-section",
  "title": "My Section",
  "keywords": ["keyword1"],
  "content": [...]
}

セクションを更新

PUT /_emdash/api/sections/:slug

セクションを削除

DELETE /_emdash/api/sections/:slug

設定エンドポイント

すべての設定を取得

GET /_emdash/api/settings

設定を更新

POST /_emdash/api/settings
Content-Type: application/json

{
  "siteTitle": "My Site",
  "tagline": "A great site",
  "postsPerPage": 10
}

メニューエンドポイント

メニューを一覧表示

GET /_emdash/api/menus

メニューを取得

GET /_emdash/api/menus/:name

メニューを作成

POST /_emdash/api/menus
Content-Type: application/json

{
  "name": "footer",
  "label": "Footer Navigation"
}

メニューを更新

PUT /_emdash/api/menus/:name

メニューを削除

DELETE /_emdash/api/menus/:name

メニュー項目を追加

POST /_emdash/api/menus/:name/items
Content-Type: application/json

{
  "type": "page",
  "referenceCollection": "pages",
  "referenceId": "page_about",
  "label": "About Us"
}

メニュー項目を並べ替え

POST /_emdash/api/menus/:name/reorder
Content-Type: application/json

{
  "items": [
    { "id": "item_1", "parentId": null, "sortOrder": 0 },
    { "id": "item_2", "parentId": null, "sortOrder": 1 },
    { "id": "item_3", "parentId": "item_2", "sortOrder": 0 }
  ]
}

タクソノミーエンドポイント

タクソノミー定義を一覧表示

GET /_emdash/api/taxonomies

タクソノミーを作成

POST /_emdash/api/taxonomies
Content-Type: application/json

{
  "name": "genre",
  "label": "Genres",
  "labelSingular": "Genre",
  "hierarchical": true,
  "collections": ["books", "movies"]
}

タームを一覧表示

GET /_emdash/api/taxonomies/:name/terms

タームを作成

POST /_emdash/api/taxonomies/:name/terms
Content-Type: application/json

{
  "slug": "tutorials",
  "label": "Tutorials",
  "parentId": "term_abc",
  "description": "How-to guides"
}

タームを更新

PUT /_emdash/api/taxonomies/:name/terms/:slug

タームを削除

DELETE /_emdash/api/taxonomies/:name/terms/:slug

エントリーのタームを設定

POST /_emdash/api/content/:collection/:id/terms/:taxonomy
Content-Type: application/json

{
  "termIds": ["term_news", "term_featured"]
}

ウィジェットエリアエンドポイント

ウィジェットエリアを一覧表示

GET /_emdash/api/widget-areas

ウィジェットエリアを取得

GET /_emdash/api/widget-areas/:name

ウィジェットエリアを作成

POST /_emdash/api/widget-areas
Content-Type: application/json

{
  "name": "sidebar",
  "label": "Main Sidebar",
  "description": "Appears on posts"
}

ウィジェットエリアを削除

DELETE /_emdash/api/widget-areas/:name

ウィジェットを追加

POST /_emdash/api/widget-areas/:name/widgets
Content-Type: application/json

{
  "type": "content",
  "title": "About",
  "content": [...]
}

ウィジェットを更新

PUT /_emdash/api/widget-areas/:name/widgets/:id

ウィジェットを削除

DELETE /_emdash/api/widget-areas/:name/widgets/:id

ウィジェットを並べ替え

POST /_emdash/api/widget-areas/:name/reorder
Content-Type: application/json

{
  "widgetIds": ["widget_1", "widget_2", "widget_3"]
}

ユーザー管理エンドポイント

ユーザーを一覧表示

GET /_emdash/api/admin/users
GET /_emdash/api/admin/users?role=40
GET /_emdash/api/admin/users?search=john

ユーザーを取得

GET /_emdash/api/admin/users/:id

ユーザーを更新

PUT /_emdash/api/admin/users/:id
Content-Type: application/json

{
  "name": "John Doe",
  "role": 40
}

ユーザーを有効化

POST /_emdash/api/admin/users/:id/enable

ユーザーを無効化

POST /_emdash/api/admin/users/:id/disable

認証エンドポイント

セットアップステータス

GET /_emdash/api/setup/status

セットアップが完了しているか、ユーザーが存在するかを返します。

パスキーログイン

POST /_emdash/api/auth/passkey/options

WebAuthn認証オプションを取得します。

POST /_emdash/api/auth/passkey/verify
Content-Type: application/json

{
  "id": "credential-id",
  "rawId": "...",
  "response": {...},
  "type": "public-key"
}

パスキーを検証してセッションを作成します。

マジックリンク

POST /_emdash/api/auth/magic-link/send
Content-Type: application/json

{
  "email": "user@example.com"
}

GET /_emdash/api/auth/magic-link/verify?token=xxx

ログアウト

POST /_emdash/api/auth/logout

現在のユーザー

GET /_emdash/api/auth/me

ユーザーを招待

POST /_emdash/api/auth/invite
Content-Type: application/json

{
  "email": "newuser@example.com",
  "role": 30
}

パスキー管理

GET /_emdash/api/auth/passkey

ユーザーのパスキーを一覧表示します。

POST /_emdash/api/auth/passkey/register/options
POST /_emdash/api/auth/passkey/register/verify

新しいパスキーを登録します。

PATCH /_emdash/api/auth/passkey/:id
Content-Type: application/json

{
  "name": "MacBook Pro"
}

パスキーの名前を変更します。

DELETE /_emdash/api/auth/passkey/:id

パスキーを削除します。

インポートエンドポイント

WordPressエクスポートを分析

POST /_emdash/api/import/wordpress/analyze
Content-Type: multipart/form-data

file: <WXR file>

WordPressインポートを実行

POST /_emdash/api/import/wordpress/execute
Content-Type: application/json

{
  "analysisId": "...",
  "options": {
    "includeMedia": true,
    "includeTaxonomies": true,
    "includeMenus": true
  }
}

レート制限

APIエンドポイントは、デプロイメント構成に基づいてレート制限される場合があります。レート制限時、レスポンスには次が含まれます:

HTTP/1.1 429 Too Many Requests
Retry-After: 60

CORS

APIはブラウザリクエストのCORSをサポートしています。デプロイメントで許可されたオリジンを構成してください。