シノプシス
Ansys

Synopsys Cloud OpenLink API仕様ドキュメント

README.md

バージョン 2023.10.20.001

著作権および独自情報に関する通知
© 2023 Synopsys, Inc. 本Synopsys Cloud OpenLinkアプリケーションプログラミングインターフェイス(API)および関連するすべてのドキュメントは、Synopsys, Inc.の専有財産であり、Synopsys, Inc.との書面による契約の諸条件に従ってのみ使用できます。

免責事項
Synopsys, Inc.およびそのライセンサーは、商品性および特定目的への適合性の黙示の保証を含みますがこれらに限定されず、本資料に関して明示的か黙示的かを問わず、いかなる保証も行いません。

商標
Synopsysおよび特定のSynopsys製品名は、https://www.synopsys.com/company/legal/trademarks-brands.htmlに記載されているSynopsysの商標です。その他の製品名または会社名は、それぞれの所有者の商標である場合があります。

サードパーティへのリンク
本書に含まれるサードパーティ製ウェブサイトへのリンクは、お客様の利便性のみを目的として提供されています。Synopsysは、かかるウェブサイトおよびそのプライバシー慣行、可用性、コンテンツについて、推奨するものではなく、一切の責任を負いません。


本書では、半導体ファウンドリ、EDAおよびIPベンダーがSynopsys Cloudとシステム間で相互運用できるようにするSynopsys Cloud OpenLink APIについて説明します。具体的には、ベンダーはSynopsys Cloudの顧客に対する自社製品のエンタイトルメント(権利)に関する情報を提供できます。顧客はAPIを使用してベンダーにライセンスを要求できます。その後、ライセンスがSynopsys Cloudにインストールされます。 本書のスコープには、以下のSynopsys Cloud OpenLink API機能が含まれます。

  • ベンダーエンタイトルメント:サードパーティベンダーが、特定の顧客に対する利用可能なライセンスエンタイトルメントのリストをSynopsys Cloudに提供する
  • ベンダーライセンス要求:サードパーティベンダーが、特定の顧客による使用のためにSynopsys Cloudへインストールするライセンスファイルを提供する

高レベルフロー

  • A Synopsys Cloudの顧客 Synopsys CloudポータルUIの「Third-Party Entitlements(サードパーティ製エンタイトルメント)」ページに移動する
  • vBSIMM 顧客 選択する ベンダー エンタイトルメントを参照し、最終的にライセンスを要求する対象となる
  • Synopsys Cloud を介して、顧客の利用可能なエンタイトルメントを取得する ベンダー エンタイトルメントAPIエンドポイント
  • vBSIMM ベンダー APIレスポンスに利用可能なエンタイトルメントのリストが記載され、UIによって表示される
  • vBSIMM 顧客 ライセンスを要求するエンタイトルメントの数量を選択し、要求を送信する
  • Synopsys Cloud ライセンスAPIエンドポイントを ベンダー 呼び出します。
  • vBSIMM ベンダー 応答としてライセンスファイルが提供され、それらが Synopsys Cloud ライセンスサーバー

 

Synopsys Cloud OpenLink API仕様書(.yaml)

README.md

以下の図は、ライセンスフローを示しています。

このセクションのシーケンスチャート図は、以下のフローの基本を示しています。

  • OAuth2ベースの認証(OAuth2およびAPIキーをサポート)
  • エンタイトルメントの取得
  • ライセンス要求の構成
  • ライセンスの要求


Synopsys Cloudとの統合用APIは、OpenAPI v3標準に準拠して規定されています。この仕様書には、APIの実装に必要なすべての詳細が含まれています。このセクションでは、仕様書を明確にするための追加情報を提供します。

  • 仕様書は、オンラインのSwagger Editorツールを使用して確認できます。
  • オンラインのSwagger Editorツールを使用して、クラウドサービスとして任意のプログラミング言語(Node.js、Java、Python、Rubyなど)で動作するリファレンスサーバーやクライアントを自動生成することもできます。

このセクションでは、Synopsys Cloud OpenLink APIの共通プロパティについて説明します。

  • httpsおよび TLS 2.0 以降によるセキュアなデータ転送のみが https サポートされています。
  • リクエストでは Content-Type: application/json のみがサポートされます。
  • OAuth2 および APIキーによる認証がサポートされています。
  • UIからベンダーに対して直接リクエストが送信されることはありません。ベンダーのエンドポイントに対するすべてのリクエストは、定義されたネットワーク上のSynopsys Cloudサービスレイヤー内で保護されたサービスから開始されます。
  • UIがベンダーのAPI情報を取得することは一切ありません。URL、認証方式、認証URL、APIキーなどのすべてのベンダーAPI情報は、Synopsys Cloudサービスレイヤー内のみで処理され、お客様のクライアントデバイス上のUIに送信または公開されることは一切ありません。

各ベンダーは、手動のオンボーディングフローを通じて権利確認APIをSynopsys Cloudに登録します。ベンダー側でお客様を特定するために使用されるお客様固有の詳細情報は合意の上、Synopsys Cloudにお客様ごとに保存されます。

オンボーディングに必要な情報の種類を次の表にまとめます。

プロパティ オプション
ベンダーの認証方式 APIキー、またはOAuth 2
ベンダーの認証API URL、パラメータ、ヘッダー
ベンダーの権利確認クエリAPI URL、パラメータ、ヘッダー
ベンダー側のお客様識別情報 必須フィールドのリスト

ベンダーAPIのオンボーディング情報は、次のスキーマに従って登録されます。簡略化のため、このセクションで以降に説明する情報は以下でラップされています。 <>

のSwagger OpenAPI仕様を参照してください。 VendorApiRegistration

{ "auth":"OAUTH2", "oAuthApi":<vendorAuthApi>, "entitlementApi":<vendorEntitlementApi>, "customerIdentification":{ "params":<vendorCustomerFields> } }

ライセンス生成用のAPIエンドポイントは、権利確認クエリの結果に応じて動的に提供されます。これにより、 ベンダー はライセンスごとに異なるエンドポイントを提供できるようになります。 次のセクションでは、 ベンダー に登録された情報の具体的なプロパティについて詳しく説明します。 Synopsys Cloud

オンボーディング情報 - お客様識別プロパティ

vBSIMM 顧客 は、 ベンダー を通じて D-U-N-S (企業の固有の9桁の識別子)番号です。さらに、 ベンダー は、 顧客 を通じて Synopsys Cloud からベンダーに提供される追加のパラメータを指定できます。

オンボーディングの VendorApiRegistration スキーマでは、顧客識別プロパティである customerIdentification により、 vendor`` は、からへのAPI呼び出しとともに提供されるオプショナルな顧客フィールドを定義します。 Synopsys Cloudへベンダーとなります。

のSwagger OpenAPI仕様を参照してください。 VendorCustomerInfo

オプショナルな顧客フィールドの例を以下に示します。ここでは、ベンダーが顧客に対して必須の文字列パラメータの提供を求めています。 siteId.

... "customerIdentification":{ "params":[ { "title":"Site Id", "key":"siteId", "type":"String", "required":true } ... ] }

上記の必須パラメータで指定された値は、エンタイトルメントおよびライセンス取得のAPIリクエストとともに、プロパティ vendorCustomerIdentification の下で提供されます。

オンボーディング情報 – ベンダー・エンタイトルメントAPI

エンタイトルメントAPIは、オンボーディング時に提供する必要がある静的なURLです。ライセンスを取得するためのさらなるAPI情報は、エンタイトルメントAPIを使用して動的に提供されます。

{ "url": "https://api.vendor.com/v1/synopsys/get-entitlements", "header": { "my-extra-info":"anything" }, "staticbody": { "my-extra-info":"anything" } }

の下で定義されたプロパティは、 staticBody エンタイトルメントのPOSTリクエストのボディにマージされます。

オンボーディング情報 – ベンダー・ライセンス要求APIキー認証

APIキー認証の場合、 ベンダー はAPIキーのヘッダーと値を指定する必要があります。

のSwagger OpenAPI仕様を参照してください。 ApiKeyAuthInfo

必要なオンボーディング情報の例: ApiKeyAuthInfo 以下に示します:

{ "header":"x-api-key", "value":"9114dd77-912e-4179-a8c5-0a8de9dd44cc" }

vBSIMM Synopsys Cloud サービス開始時、次の例に示すように、エンタイトルメントAPIおよびライセンス生成APIへの各リクエストのヘッダーにAPIキーが指定されます:

{ "headers": { "x-api-key":"9114dd77-912e-4179-a8c5-0a8de9dd44cc" } }

オンボーディング情報 - OAuth 2.0ベースの認証

に準拠した2クライアント認証(2-legged OAuth 2.0)の場合、 RFC 6749 からAPIオンボーディングに必要な認証URL、クライアントID、およびクライアントシークレットが提供されます。 ベンダー これらのパラメータに、POSTリクエストのボディにマージされる追加の静的パラメータを付加することも可能です。

のSwagger OpenAPI仕様を参照してください。 Oauth2ClientInfo

必要なオンボーディング情報の例: Oauth2ClientInfo をここに示します:

{ "url": "https://vendor.com/api/oauth2/token", "header": { "x-my-header": "xyz" }, "staticBody": { "origin": "synopsys" }, "clientId": "6779ef20e75817b79602", "clientSecret": "dl9aUnVyOWdtQ3gxTTlobGU5N2ZWQUd5amdCcUsya2hWdVlMZmZOLWVOZw==" }

ベンダーエンタイトルメントAPI

エンタイトルメントAPIにより、 Synopsys Cloud は、特定の ベンダー に対して 顧客.

から利用可能なエンタイトルメントを取得できます。

Vendor Entitlement API - Request Synopsys Cloud から、ボディパラメータとしてエンコードされた以下の値を使用してPOSTリクエストが送信されます:

SWAGGER:Swagger OpenAPI仕様については以下を参照してください EntitlementsRequestDto:

{ "customer": { "name": "Big Chip Semi", "dunsNumber": "1232234345", "synopsysCustomerId": "5a8649c7-129e-447b-afb2-77b778e66ac3", "vendorCustomerIdentification":{ "sideId": "32668" } } }

この情報は、 ベンダー が 顧客vBSIMM vendorCustomerIdentification を特定するために使用されます。プロパティは、 Synopsys Cloud のベンダーAPIオンボーディングプロセス中に登録されます。

Vendor Entitlement API - Response

から呼び出されると、 Synopsys CloudエンタイトルメントAPIは次のスキーマに従って応答する必要があります:

SWAGGER: OpenAPI Swaggerの仕様については、以下を参照してください。 EntitlementsResponse

{ "customer": { }, // Same as in the request dto "provides":[ ] // Array with entitlement information, See under "Item Type" for possible values }

配列が含む可能性のあるコンテンツの詳細については は以下を提供します 、次のセクションで説明されています 次のセクション。すべてのライセンスを同じエンドポイントから提供できる場合 ベンダー、配列のエントリは1つのみとなる場合があります。各エントリには、単一のライセンス取得エンドポイントを介してライセンスを取得できるすべてのエンタイトルメントがリストされます。異なるエンドポイントが必要な場合は、異なるエンドポイント設定を持つ複数のアイテムを指定できます。

アイテムタイプ – ライセンスエンタイトルメント

このアイテムタイプは、 ベンダー がすべてのライセンスエンタイトルメントを公開し、 Synopsys Cloud 顧客 がライセンスを要求できるようにするために使用されます。

  • ライセンスは、Synopsys Cloud内の 顧客のライセンスサーバーに自動的にインストールされます。
  • ライセンスは、 ベンダー
  • によって1つまたは複数のファイルとして提供できます。ライセンスファイルは、 ベンダー によって、後続のライセンス取得エンドポイントで同期または非同期で提供できます。

SWAGGER: OpenAPI Swaggerの仕様については、以下を参照してください。 LicenseEntitlements

配列の一部である LicenseEntitlements アイテムの EntitlementsResponse は以下を提供します の例をここに示します。

{ "customer": { "name": "Big Chip Semi", "dunsNumber": "1232234345", "synopsysCustomerId": "5a8649c7-129e-447b-afb2-77b778e66ac3", "vendorCustomerIdentification":{ "sideId": "32668" } }, "provides": [ { "title": "AutoChip EDA Tools", "description": "Digital Design EDA Tools Licenses", "kind": "ProvideLicense", "licenseEntitlements": [ { "title": "Power Analyzer", "aux":{"part": "part-1234"}, "qtyMax":10, "termEndDate": "2024-08-01T00:00:00.000Z" }, { "title": "Timing Analyzer", "aux":{"part": "part-5678"}, "qtyMax":5, "termEndDate": "2025-08-01T00:00:00.000Z" } ], "licenseRequestApi":{ "url": "localhost:2000/get-license", "header": { "x-my-header": "xyz" }, "staticBody": { "origin": "synopsys" }, }, } ] }

各エンタイトルメントアイテムには、以下を含める必要があります。

  • A title
  • 任意の 説明利用可能な最大数量 qtyMaxライセンス期間の終了日 termEndDate
  • プロパティの下でライセンス要求に関連付けるための任意の補助情報 補助.

ライセンス要求のために、 title および 補助 オブジェクトが要求数量とともに提供されます。 qtyMax ベンダーライセンス生成エンドポイントへ送信されます。

ベンダーライセンス要求API

UIで要求数量を設定した後、ライセンスを要求するための ベンダー エンドポイントが Synopsys Cloudから呼び出されます。要求に対する応答として、 ベンダー が要求されたライセンスを提供するか、エラーを返します。

  • 必要に応じて、 ベンダー によって複数のライセンスファイルを送信することができます。各ライセンスファイルは、 Synopsys Cloud から同期または非同期(ポーリング)で ベンダー.
  • ライセンス生成に要する時間が20秒未満の場合は、同期応答方式を使用してください。
  • ライセンス生成に要する時間が20秒を超える場合は、非同期応答方式を使用してください。

SWAGGER: OpenAPI Swaggerの仕様については、以下を参照してください。 ProvideLicenseRequestDto

からライセンスを要求するための ProvideLicenseRequestDto アイテムの例を以下に示します: ベンダー

{ "customer": { "name": "Big Chip Semi", "dunsNumber": "1232234345", "synopsysCustomerId": "5a8649c7-129e-447b-afb2-77b778e66ac3", "vendorCustomerIdentification":{ "sideId": "32668" } }, "licenseRequests": [ { "title": "Power Analyzer", "aux":{"part": "part-1234"}, "qty": 2 }, { "title": "Timing Analyzer", "aux":{"part": "part-5678"}, "qty": 3 } ], "host": { "id": "id-auto-filled-by-snps", "name": "auto-filled-by-snps" }, "origin": "synopsys", }

応答 - ライセンスファイル生成

ライセンス要求エンドポイントの応答では、ライセンスファイルを応答の一部として同期的に提供することも、ポーリングされるダウンロードURLを通じて非同期的に提供することもできます。

SWAGGER: Swagger Typeをご参照ください ProvideLicenseResponse

同期応答 - ライセンスファイルの生成

同期応答では、HTTP POSTレスポンスボディの一部としてライセンスファイルが直接提供されます。 この応答タイプは、20秒未満でライセンスファイルプロビジョニングできる場合に使用され、これによりHTTPのタイムアウトを防ぎます。

同期応答は、ペイロード内のプロパティ downloadType が次のように設定されていることで示されます: "Sync" プロパティ データ には、1つまたは複数のライセンスの filename およびタイプとともにデータを格納できます。ライセンスの場合、プロパティ fileType は次のように設定する必要があります "License" 以下の例をご覧ください:

{ "files": [ { "fileName": "lic_vendor_tool.lic", "fileType": "License", "data": "<Buffer 48 61 6c 6c 6f>", "downloadType": "Sync" } ] }

fileプロパティ データ には、 Base64 エンコードされたライセンスファイルがバッファとして含まれます。プレーンJavaScriptでの Base64 エンコーディングの例を以下に示します

const licenseString = 'SERVER enterp ...'; const buff = new Buffer(licenseString); const data = buff.toString('base64');
非同期応答 - ライセンスファイルの生成

非同期応答では、HTTP POSTレスポンスの一部としてライセンスファイルが直接提供されることはありません。

その代わりに、レスポンス内でベンダーが指定した時間が経過した後にライセンスファイルをダウンロードできるURLが提供されます。 この応答タイプは、HTTPのタイムアウトを防ぐためにライセンスファイルのプロビジョニングに20秒以上かかる場合に使用されます。以下の図は、インタラクションモデルを示しています:

非同期応答は、ペイロード内のプロパティ fileType が次のように設定されていることで示されます: "Async" によって示されます。 データライセンスの配列では、例文に示すように、(ライセンスファイルデータの代わりに)ライセンスファイルのダウンロード手順が示されます。

{ "files": [ { "fileType": "Async", "fileName": "lic_vendor_tool.lic", "downloadType": "License", "downloadApi":{ "url": "http://vendor.com/download?uuid=eec85dab-6de8-4f1f-8234-6df676bdb834", "headers": { "x-my-header": "xyz" }, "staticBody": { "origin": "synopsys" }, "pollStartDateTime": "2023-07-12T09:40:18.000Z", "pollIntervalSec": 30 } } ] }

プロパティ url は、ダウンロード用URLに加え、メソッド、任意の headers、および任意の本体パラメータを次のもので提供します: staticBody。ISO日付文字列プロパティ pollStartDateTime は、Synopsysがダウンロードを試行すべき時期と、提案されるポーリング間隔を示します(使用: pollIntervalSec)。ファイルがまだ利用できない場合、 404 の応答が返されます。

エラー応答

REST APIへの入力としてパラメータの検証に失敗した場合、各エンドポイントは次のステータスコードでエラーを返す必要があります: 400 (以下に示すとおり)

{ "code": "LICGEN001", "message": "License generation failed", "statusCode": 400, "tid": "eec85dab-6de8-4f1f-8234-6df676bdb834", "errors": [ { "message": "LmHostId is missing but required" } ] }

プロパティ code は、ベンダー固有のエラーコードのエンコーディングを可能にします。 message には、 顧客にフィードバックされるエラーに関する情報が含まれます。オプショナルプロパティ tid により、 ベンダー 追跡とデバッグ用のサーバー・トレースIDの挿入が可能になります。これは、500内部サーバーエラーに対して特に有効です。オプションのerrors配列には、追加のエラー情報(個別のパラメータに関する特定のエラーなど)を含めることができます。

サンプル実装(Node.js)

以下のコードは、Node.jsおよびJavaScriptを使用したSynopsys® Cloud OpenLink API仕様のシンプルかつ実用的なサンプル実装を示しています。

/** * NodeJS example application of the Synopsys® Cloud OpenLink API Specification * * npm install express * npm install body-parser * node main.js * */ const express = require('express') const bodyParser = require('body-parser') const app = express() /* * Server settings */ const port = 2000 const host = 'localhost' const protocol='http' app.use(bodyParser.json()) // Some tracing... app.use((req,res,next)=>{ console.log(`TRACE: ${req.method} ${req.url}`) next(); }) /** * Example implementation for get-license API */ app.use('/vendor-api/get-license', async (req, res) => { // Vendor sample endpoint to generate a license with synchronous response console.log(req.body) const customer = req.body.customer const hostId = req.body.host.id; const hostName = req.body.host.name; let response = { files: [] } const backOfficeLicenseGeneration=async ()=>{ return "DUMMY LICENSE FILE...." } /* Here, we generate a license per part as one possible option */ for (let licenseRequest of req.body.licenseRequests) { /* Vendor's backoffice call to generate license*/ const licenseFile = await backOfficeLicenseGeneration(customer, hostName, hostId, licenseRequest.qty, licenseRequest.expiry, licenseRequest.aux.part) response.files.push({ files: [{ fileType: "Sync", data: Buffer.from(licenseFile, 'base64'), fileName: `lic ${hostId}.txt`, downloadType: "License" } ] }) } /* Respond to Synopsys with generated licenses */ res.json(response) }) /** * Example implementation for get-entitlements API */ app.post('/vendor-api/get-entitlements', (req, res) => { /* Vendor sample endpoint to query entitlements and map user options to vendor's get-license API spec */ const response = { "customer": req.body?.customer, "provides": [ { "title": "AutoChip EDA Tools", "description": "Digital Design EDA Tools Licenses", "kind": "ProvideLicense", "licenseEntitlements": [ { "title": "Power Analyzer", "aux":{"part": "part-1234"}, "qtyMax":10, "termEndDate": "2024-08-01T00:00:00.000Z" }, { "title": "Timing Analyzer", "aux":{"part": "part-5678"}, "qtyMax":5, "termEndDate": "2025-08-01T00:00:00.000Z" } ], "licenseRequestApi":{ "url":`${protocol}://${host}:${port}/vendor-api/get-license`, "header": { "x-my-header": "xyz" }, "staticBody": { "origin": "synopsys" }, }, } ] } res.json(response) }) app.listen(port, () => { console.log(`Example Synopsys® Cloud OpenLink API vendor server listening on port ${port}`) })

Ask BETA This experience is in beta mode. Please double check responses for accuracy.

チャットを終了する

このウィンドウを閉じると、チャット履歴が消去され、セッションが終了します。本当に このチャットを終了してもよろしいですか?