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プロファイル
  保存および新規バージョンとして保存の権限
• PATCHプロファイル
  既存のバージョンを保存または新規バージョンとして保存の権限

認証

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

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