環境間のAPI設定のマージは、開発・検証環境で確認した設定を本番環境へ反映したり、本番環境で変更した設定を開発・検証環境へ反映したりする際に利用できる機能です。
環境間でAPI設定の差分を比較し、反映したいAPIを選択することで、APIの基本情報・スキーマやカスタムフィールドの設定をまとめて反映できます。
マージは、別環境から本番環境への反映だけでなく、本番環境から別環境へ、別環境同士の反映にも対応しています。
環境間のAPI設定のマージはBusinessプラン、Enterpriseプランでご利用いただける機能です。 プランごとの利用条件については、料金プランをご確認ください。
マージを実行すると、マージ先のAPI設定が変更されます。差分の内容によっては、APIやフィールドの新規作成・変更・削除が発生します。マージ元とマージ先、差分内容を十分に確認してから実行してください。マージによって失われたデータは、誤って削除した場合でも、弊社での復旧対応は承っておりません。
設定を反映したい環境を開き、環境設定から［API設定のマージ］を選択します。
現在表示している環境がマージ先になります。
マージ元の環境を選択します。
例：ステージング環境の設定を本番環境へ反映する場合
［差分を確認する］ボタンをクリックすると、環境間で差分のあるAPIが表示されます。左側の一覧では、差分の種類ごとにAPIを確認できます。
APIを選択すると、差分が表示されます。以下の内容を確認し、マージしたいAPIのチェックボックスにチェックを入れてください。
マージ元に存在せず、マージ先にのみ存在するAPIやフィールドは、削除対象になる場合があります。詳しくは「マージ元に存在しないAPIやフィールドがある場合」をご確認ください。
［マージ内容を確認する］ボタンをクリックし、選択したAPIについて以下を確認します。
内容に問題がないことを確認したら、画面下部の［マージを実行する］をクリックします。
マージが開始されると、処理順序に沿ってAPIごとの処理状況が表示されます。すべての処理が「成功」となり、「マージ完了」と表示されたらマージは完了です。
処理に失敗した場合、後続のAPIの処理はスキップされます。対応方法は「その他の注意事項」をご確認ください。
マージによって新しいAPIが作成され、契約プランのAPI数上限を超える場合、追加料金が発生することがあります。
複数環境機能で作成した環境では権限管理を利用できないため、マージの実行に必要な権限は、マージ元・マージ先に本番環境が含まれるかどうかによって異なります。
マージに関係する権限は、次の2つです。
基本的には、マージ元では読み取り、マージ先では変更操作に必要な権限が求められます。
環境への読み取り権限が「URLを知っている環境のみ」のロールでは、マージ元の環境を一覧から選択できません。そのため、本番環境から現在表示している環境へのマージのみ実行できます。
マージ方向 | マージ元 | マージ先 |
|---|---|---|
本番環境 → 別環境 | ||
別環境 → 本番環境 | ||
別環境 → 別環境 |
マージの対象は、API設定とカスタムフィールドの設定のみです。コンテンツやメディアは、マージ元からコピーされません。
以下のフィールドは、フィールド設定自体はマージ対象ですが、設定された初期値はマージされません。マージ先の既存のフィールドでは、初期値がそのまま残ります。新しく作成されたフィールドでは、マージ後にマージ先の環境で設定してください。
以下の設定は、マージの対象外です。
これらの設定は、マージ元とマージ先で異なっていても差分として検知されないため、マージ先の設定がそのまま残ります。マージによって新しく作成されたAPIでは未設定の状態になるため、必要に応じてマージ先の環境で設定してください。
変更内容によっては、マージ先で既存の設定を更新するのではなく、対象を削除したり、削除してから新しく作成したりする場合があります。
APIのエンドポイントを変更すると、マージ先では既存APIの更新ではなく、削除と再作成として処理されます。
ただし、リスト形式のAPIで、削除対象のAPIにコンテンツが存在する場合は、APIを削除できないため、マージを実行できません。
オブジェクト形式のAPIは、コンテンツが存在していても削除と再作成が実行されます。その場合、既存のコンテンツは失われます。
また、削除対象のAPIが他のAPIから参照されている場合は、参照元のAPIもあわせてマージ対象に含めるか、先にマージする必要があります。その場合、参照元のAPIのコンテンツ参照フィールド・複数コンテンツ参照フィールドは削除と再作成が行われ、フィールドに設定されていた値は削除されます。
マージ内容の確認画面で、マージ可否と注意事項を確認してください。
推奨する対応
マージ先のAPIのエンドポイントを変更すると、Webhookの実行や、APIを利用しているサイト・外部サービスとの連携などに影響する場合があります。影響範囲を確認してから変更してください。
環境の作成後に、それぞれの環境で個別に追加したフィールドやカスタムフィールドは、マージ元とマージ先でIDが異なると、同じものと判定されません。その場合、マージ先では既存のフィールドの更新ではなく、削除と再作成として処理されます。コンテンツは削除されませんが、フィールドに設定されていた値は削除されます。
なお、環境の作成時から存在するフィールドやカスタムフィールドは、IDを変更しても同じものとして判定されます。
マージ内容の確認画面で、マージ可否と注意事項を確認してください。
推奨する対応
マージ先のフィールドIDやカスタムフィールドIDを変更すると、Webhookの実行や、APIを利用しているサイト・外部サービスとの連携などに影響する場合があります。影響範囲を確認してから変更してください。
マージでは、マージ元のAPI設定を基準にマージ先の設定を更新します。そのため、マージ元に存在せず、マージ先にのみ存在するAPIやフィールドは削除対象になります。例えば、マージ先の環境で独自に追加したフィールドは、マージ元に存在しないため削除されます。
削除対象のAPIやフィールドにコンテンツが設定されている場合、その値は失われる可能性があります。マージ先のAPIやフィールドを残したい場合は、差分確認画面で削除対象を確認し、対象のAPIをマージ対象から外してください。
