ここでは、APIを使用して、アプリの作成およびアプリの設定変更を行う方法を説明します。同じ設定を大量のアプリに適用するようなケースでは、APIを使用することで、効率よく設定を適用できます。

アプリの作成と設定変更の流れ

アプリの作成、および設定の変更は、次の流れで行います。
既存のアプリの設定を変更する場合は、Step 1は不要です。Step 2と3のみ行います。

Step 1 動作テスト環境にアプリを作成する

アプリを作成します。このステップは、新しくアプリを作成する場合のみ必要です。
アプリは動作テスト環境で作成されます。Step 3で運用環境に設定を反映するまでは、作成したアプリは使用できません。
※動作テスト環境とは、アプリがデプロイされる前に一時的にアプリの情報が保存される場所を指します。

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/app.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app.json

※このAPIの実行は、APIリクエスト数としてカウントされません。

HTTPメソッド

POST

必要なアクセス権

アプリの作成権限

※このAPIの実行には、APIトークンは使用できません。

リクエストパラメータ

リクエストの例

ヘッダ

POST /k/v1/preview/app.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンスパラメータ

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

Step 2 アプリを設定する

アプリに必要な設定を適用します。
アプリの設定を変更する方法は、以下のそれぞれのページを参照してください。

• 一般設定の変更
• フォームの設定の変更
• 一覧の設定の変更
• アプリのアクセス権の変更
• アプリのプロセス管理の設定の変更
• レコードのアクセス権の変更
• フィールドのアクセス権の変更
• JavaScript / CSSカスタマイズ設定の変更

Step 3 運用環境にアプリの設定を反映する

アプリの設定を完了し、運用環境にアプリの設定を反映します。
アプリの設定の運用環境への反映

これで、アプリの設定は完了です。