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

動作原理

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

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

iQプロファイルは現在、以下の2つのリクエストをサポートしています：

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

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

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

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

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

PATCHコールが成功した後、このプロファイルを公開するには、アプリケーションにログインし、パッチ後に保存されたプロファイルの最新バージョンに移動して公開します。

権限要件

GET Profile
新しいバージョンとして保存および保存する権限
PATCH Profile
既存のバージョンを保存する権限または新しいバージョンとして保存する権限

認証

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

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