Asset Compute Service HTTP API asset-compute-http-api

この API の使用は開発目的に限られています。この API は、カスタムアプリケーションの開発用として提供されます。Adobe Experience Manager as a Cloud Service では、この API を使用して処理情報をカスタムアプリケーションに渡します。詳しくは、アセットマイクロサービスと処理プロファイルの使用を参照してください。

Asset Compute Service HTTP API のクライアントはすべて、次の大まかなフローに従う必要があります。

adobe-asset-compute-client モジュールを利用すると、Node.js コードで API を簡単に使用できます。

認証と承認 authentication-and-authorization

すべての API にはアクセストークン認証が必要です。リクエストには、次のヘッダーを設定する必要があります。

スコープ scopes

アクセストークンのスコープを確認します。

これらのスコープでは、Adobe Developer Console プロジェクトで Asset Compute、I/O Events、I/O Management API の各サービスを購読する必要があります。個々のスコープの内訳は次のとおりです。

登録 register

Asset Compute service の各クライアント（このサービスをサブスクライブしている一意の Adobe Developer Console プロジェクト）は、処理リクエストをおこなう前に登録する必要があります。登録ステップは、レンディション処理から非同期イベントを取得するために必要な固有のイベントジャーナルを返します。

ライフサイクルの終わりに、クライアントは登録解除できます。

登録リクエスト register-request

この API 呼び出しは、Asset Compute クライアントを設定し、イベントジャーナル URL を提供します。このプロセスはべき等性がある操作であり、クライアントごとに 1 回だけ呼び出す必要があります。このメソッドを再度呼び出せば、ジャーナル URL を取得できます。

登録応答 register-response

HTTP ステータスコードは次のとおりです。

登録解除リクエスト unregister-request

この API 呼び出しは、Asset Compute クライアントの登録を解除します。この登録解除が行われると、/process を呼び出すことができなくなります。未登録のクライアントに対してこの API 呼び出しを使用すると、404 エラーが返されます。

登録解除応答 unregister-response

ステータスコードは次のとおりです。

処理リクエスト process-request

process 操作では、リクエスト内の指示に基づいてソースアセットを複数のレンディションに変換するジョブを送信します。正常完了（イベントタイプ rendition_created）または任意のエラー（イベントタイプ rendition_failed）に関する通知がイベントジャーナルに送信されます。このジャーナルは、/process リクエストを行う前に /register を 1 回使用して取得する必要があります。形式が正しくないリクエストは即座に失敗し、400 エラーコードが返されます。

バイナリは、Amazon AWS S3 の事前署名済み URL や Azure Blob Storage SAS URL などの URL を使用して参照されます。source アセットの読み取り（GET URL）とレンディションの書き込み（PUT URL）の両方に使用されます。これらの署名済み URL の生成はクライアントが担当します。

処理リクエスト JSON process-request-json

/process のリクエスト本文は、次の大まかなスキーマに従う JSON オブジェクトです。

{
    "source": "",
    "renditions" : []
}

使用可能なフィールドは次のとおりです。

source は、URL と見なされる <string> か、追加フィールドを含んだ <object> のいずれかにすることができます。次のような似たバリエーションがあります。

"source": "http://example.com/image.jpg"

"source": {
    "url": "http://example.com/image.jpg"
}

source オブジェクトのフィールド source-object-fields

完全な process リクエストの例 complete-process-request-example

{
    "source": "https://www.adobe.com/content/dam/acom/en/lobby/lobby-bg-bts2017-logged-out-1440x860.jpg",
    "renditions" : [{
            "name": "image.48x48.png",
            "target": "https://some-presigned-put-url-for-image.48x48.png",
            "fmt": "png",
            "width": 48,
            "height": 48
        },{
            "name": "image.200x200.jpg",
            "target": "https://some-presigned-put-url-for-image.200x200.jpg",
            "fmt": "jpg",
            "width": 200,
            "height": 200
        },{
            "name": "cqdam.xmp.xml",
            "target": "https://some-presigned-put-url-for-cqdam.xmp.xml",
            "fmt": "xmp"
        },{
            "name": "cqdam.text.txt",
            "target": "https://some-presigned-put-url-for-cqdam.text.txt",
            "fmt": "text"
    }]
}

処理応答 process-response

/process リクエストは、基本的なリクエスト検証に基づいて、成功または失敗を即座に返します。実際のアセット処理は非同期でおこなわれます。

ステータスコード:

ほとんどのクライアントは、401 や 403 などの設定の問題や、400 などの無効なリクエストを​ 除き、エラーが発生すると指数バックオフを使用して同じリクエストを再試行する傾向があります。429 応答による通常のレート制限とは別に、一時的なサービス停止または制限により、5xx エラーが発生する可能性があります。その場合は、しばらくしてから再試行することをお勧めします。

すべての JSON 応答（存在する場合）には、X-Request-Id ヘッダーと同じ値の requestId が含まれます。アドビでは、ヘッダーが常に存在するたので、ヘッダーから読み取ることをお勧めします。また、requestId は、処理リクエストに関連するすべてのイベントでも requestId として返されます。クライアントは、この文字列の形式についていかなる仮定も行ってはなりません。これは、不透明な文字列識別子です。

後処理へのオプトイン opt-in-to-post-processing

Asset Compute SDK では、一連の基本的な画像後処理オプションをサポートしています。カスタムワーカーは、レンディションオブジェクトの postProcess フィールドを true に設定して、後処理を明示的にオプトインすることができます。

次のユースケースがサポートされています。

アセットへの透かしの適用 add-watermark

Asset Compute SDK では、PNG、JPEG、TIFF、GIF の各画像ファイルへの透かしの追加をサポートしています。透かしは、レンディションの watermark オブジェクトのレンディション指示に従って追加されます。

透かしの追加はレンディションの後処理中におこなわれます。アセットに透かしを追加するには、レンディションオブジェクトの postProcess フィールドを true に設定して、カスタムワーカーが後処理をオプトインします。ワーカーがオプトインしない場合、リクエストのレンディションオブジェクトに透かしオブジェクトが設定されている場合でも、透かしは適用されません。

レンディション指示 rendition-instructions

以下は、/process の renditions 配列で使用可能なオプションです。

共通のフィールド common-fields

レンディション固有のフィールド rendition-specific-fields

現在サポートされているファイル形式の一覧については、サポートされているファイル形式を参照してください。

透かし固有のフィールド watermark-specific-fields

PNG 形式が透かしとして使用されます。

非同期イベント asynchronous-events

レンディションの処理が完了した場合、またはエラーが発生した場合は、Adobe I/O Events Journal にイベントが送信されます。クライアントは、/register を通じて提供されたジャーナル URL をリッスンする必要があります。ジャーナル応答は event 配列を含んでいます。その要素は各イベントに対応する 1 つのオブジェクトで、そのオブジェクトの event フィールドに実際のイベントペイロードが含まれています。

Asset Compute Service のすべてのイベントに対する Adobe I/O Events タイプは asset_compute です。ジャーナルは、このイベントタイプのみを自動的にサブスクライブし、Adobe Developer イベントタイプに基づいてさらにフィルタリングする必要はありません。このサービス固有のイベントタイプは、イベントの type プロパティで得られます。

イベントタイプ event-types

イベント属性 event-attributes

メタデータ metadata

エラー理由 error-reasons