iQプロファイルAPIについて

動作原理

iQプロファイルは、iQタグ管理構成をプログラムで利用可能にするAPIエンドポイントです。このエンドポイントを使用して、タグ、拡張機能、ロードルール、イベント、変数などの特定の構成コンポーネントを取得し、限定されたコンポーネントの追加、編集、削除を行います。

このAPIを使用して、プロファイルのバージョンと変更履歴にアクセスし、独自のSDLCを統合します。

iQプロファイルは次の3つのリクエストをサポートしています：

GET
iQタグ管理アカウントプロファイルについての特定の内容を返します。これには、ロードルール、タグ、タグテンプレート、イベント、拡張機能、変数、バージョンIDが含まれます。
PATCH
構成コンポーネントの限定されたサブセットに対して作成、更新、削除操作を実行します。この方法を使用すると、プロファイルの新しい保存バージョンが作成されます。
POST（公開）
保存されたプロファイルバージョンを1つ以上のターゲット環境に公開します。詳細については、iQ公開APIを参照してください。

同時ユーザーとAPIユーザー

プロファイルを更新する際、iQプロファイルは同時ユーザーをスキャンし、同時変更に対する保護のためにプロファイルをAPIユーザー用にロックします。別のユーザーが同じプロファイルを閲覧している場合や、プロファイルが更新されたばかりの場合（15秒以内）、PATCHメソッドはエラーを受け取ります。

保存、バージョニング、および公開

PATCHリクエストを使用してプロファイルを更新すると、アプリケーション内に新しいバージョンまたは更新されたバージョンが作成されます。APIによって生成されたバージョンとアプリケーションで作成されたバージョンを区別するために、APIはバージョン名を API | {TIMESTAMP} としてフォーマットします。

APIを介してプロファイルバージョンを公開するには、iQ公開APIを使用します。既存の保存バージョンを単独のPOSTリクエストで公開するか、保存と公開を1つのPATCH操作に組み合わせることができます。

権限要件

GETプロファイル
新しいバージョンとして保存および保存する権限
PATCHプロファイル
既存のバージョンを保存するか、新しいバージョンとして保存する権限
POST公開およびPATCH保存および公開
各要求されたターゲット環境の公開権限。APIはUIと同じプラットフォーム権限を使用します。UIでターゲットに公開できる場合、APIを使用してベアラートークンで公開できます。

認証

ベアラートークンはすべてのAPI呼び出しを認証するために使用され、APIキーは認証呼び出しでのみ使用されます。ベアラートークンに加えて、認証応答には、後続のサーバーサイドAPI呼び出しで使用する必要がある地域固有のホスト名が含まれています。

APIキーからベアラートークンを生成する方法については、認証を参照してください。