プロジェクトの作成
このガイドでは、Orizmコンソールを使用してプロジェクトを作成し、基本設定を行う方法を説明します。プロジェクトはアプリケーション開発の基本単位であり、APIやコンテンツ管理の基盤となります。
プロジェクトの作成
Orizmの開発者アカウントを持っていて、Orizmコンソールにログインしていることを前提としています。
1. プロジェクト作成を開始
- ヘッダーメニューの組織一覧から組織を選択します。
- プロジェクト一覧ページ(
https://app.orizm.com/organizations/{organizationId}
)で「+ New Project」ボタンをクリックします。
2. プロジェクト情報を入力
以下の情報を入力します:
Project Name
- システム内で使用される一意の識別子です。
- 英小文字、数字、ハイフンのみ使用可能です。
- 例:
my-first-project
、company-blog-api
プロジェクト名は作成後に変更できません。APIエンドポイントやプロジェクト参照時に使用されます。
Display Name
- コンソール上で表示される名称です。
- 自由な名前を設定できます。
- 例:
マイプロジェクト
、企業ブログAPI
3. プロジェクトを作成
すべての必須情報を入力したら「Create」ボタンをクリックします。プロジェクト作成が完了すると、新しいプロジェクトのダッシュボードに移動します。
4. プロジェクト作成後の設定
プロジェクトを作成したら、次にプロジェクトの設定を行います。プロジェクトを開き「Setting」タブへアクセスします。
CMS URL
- CMSにアクセスするためのURLです。プロジェクトユーザーが招待を受けパスワードを設定するとリダイレクトされるURLに使用します。
http://
またはhttps://
で始まる必要があります。- 例:
https://cms.example.com
Allow Origins
CORS設定として、APIへのアクセスを許可するオリジンを指定します。「追加」ボタンで複数のオリジンを指定でき、文字列または正規表現パターンで指定できます。
入力の種類 | 例 |
---|---|
文字列 | https://example.com |
正規表現 | https://.*\.example\.com |
Deletion Protection
誤ったプロジェクト削除を防止するための機能です。
削除保護が有効な場合:
- プロジェクト設定画面の「削除」ボタンが無効化またはグレーアウトされます。
- 削除APIリクエストは拒否され、エラーレスポンスが返されます。
この二段階のプロセスにより、重要なプロジェクトの誤削除や意図しない削除を防止できます。特に本番環境や重要なデータを含むプロジェクトでは、削除保護を有効にすることをお勧めします。
5. OAuth2クライアントの設定
OAuth2クライアントの設定画面は以下の手順でアクセスします。
- プロジェクト設定画面の「OAuth2 Clients」タブにアクセスします。
- 左のメニューから「OAuth Clients」をクリックします。
プロジェクトを作成するとデフォルトで Default OAuth2.0 Client
というクライアントが作成されています。クライアントの詳細を確認するには、クライアント名をクリックします。
クライアント詳細では、クライアントのIDとシークレットを確認できます。これらはCMSアプリケーションで使用します。
Redirect URIs には、OAuth2認証後にリダイレクトを許可するURLを指定します。正しく設定していない場合はCMSにログインできません。
6. ユーザーを招待
- プロジェクト画面から「User」タブにアクセスします。
- 左のメニューから「Users」をクリックします。
- 「Invite New User」の「Email」に招待したいメールアドレスを入力します。
- 「Invite」ボタンをクリックすると、入力したメールアドレス宛に招待メールが送信されます。
- 追加されたユーザーはユーザー一覧に表示されます。
ユーザーのグループとロールの追加
追加したユーザーには、個別に権限とロールを指定できます。
- ユーザー一覧の操作したいユーザーの「permission」をクリックします。
- 「Project User Permissions」モーダルで「Add Group Role」ボタンをクリックし、新しいRoleとGroupの入力エリアに任意の値を入力します。
追加したグループとロールの権限については 権限 ページを参照してください。
次のステップ
プロジェクトの作成と基本設定が完了したら、以下の作業に進みましょう:
- APIキーを発行してアプリケーション開発を始める