genko.meの基本
ワークスペース、API、コンテンツの関係と、目的に合わせたドキュメントの読み方。
genko.meは、文章や画像を管理画面で編集し、APIを通してWebサイトやアプリへ届けるヘッドレスCMSです。Next.jsではSDKがコンテンツの取得とHTML表示を担当し、ページのデザインはサイト側のCSSで指定します。
編集する人は管理画面で原稿を作成・公開し、開発する人はAPIまたはSDKでその原稿を取得します。サイトのコードを毎回変更しなくても、記事やお知らせを更新できるようになります。
最初に読むページ
| やりたいこと | 入口 |
|---|---|
| 最初の記事を作り、アプリから取得したい | クイックスタート |
| 原稿を書く・公開する手順を知りたい | コンテンツの作成と公開 |
| タイトルや本文などの項目を設計したい | APIとスキーマ・フィールド |
| 既存のアプリへ接続したい | List・Viewで表示する・クライアント設定 |
| SDKを使わずHTTPで取得したい | REST API |
| 他の人と編集したい | チームとメンバー |
| エラーを解消したい | トラブルシューティング |
コンテンツが届くまで
- ワークスペースを選ぶ。 個人用またはチーム用の作業場所です。
- APIを作る。 ブログ、お知らせ、プロフィールなど、管理する内容ごとに分けます。
- スキーマを決める。 タイトル、本文、画像などのフィールドを定義します。
- コンテンツを保存・公開する。 スキーマに沿って原稿を入力します。
- サイトから取得する。 サーバー側でAPIキーを使い、公開されたコンテンツをJSONとして取得します。
用語
| 用語 | 意味 | 例 |
|---|---|---|
| ワークスペース | API、メディア、メンバーを管理する単位。個人とチームがあります | your-workspace |
| ワークスペースID | 管理画面や配信APIのURLに使う識別子 | genko.me/your-workspace |
| API | 同じ構造のコンテンツをまとめる単位 | ブログ |
| エンドポイント | APIをURLやSDKから指定するための名前 | blog |
| スキーマ | APIに入力できる項目と、その種類・条件 | タイトルはテキスト、本文はリッチテキスト |
| フィールドID | JSONのキーやコードから参照する項目名 | title、body |
| コンテンツ/エントリ | 保存した1件の原稿 | ブログ記事1件 |
| コンテンツID | 保存時に付く不変の12文字の英数字。配信レスポンスのid | abcDEF123456 |
管理画面に表示する「名前」と、コードで使う「ID」は別です。たとえば表示名を「記事タイトル」にしても、フィールドIDがtitleなら取得するときはpost.titleです。
管理画面と配信APIの違い
管理画面では、ログインしたアカウントの権限に応じてコンテンツを読み書きします。配信APIはAPIキーで認証する読み取り用の入口で、通常は公開条件を満たしたコンテンツだけを返します。
下書きはプレビューで確認します。配信APIキーを持っているだけで、すべての下書きを一覧取得できるわけではありません。
画像やファイルはURLで配信されます。コンテンツを非公開にする操作と、ファイルへのアクセスを止める操作は同じではありません。メディア管理も確認してください。
最終更新: 2026年9月5日