버전 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의 상표입니다. 기타 모든 제품 또는 회사명은 해당 소유자의 상표일 수 있습니다.
제3자 링크
이 문서에 포함된 제3자 웹사이트 링크는 편의를 위해서만 제공됩니다. Synopsys는 이러한 웹사이트와 개인정보 처리방침, 가용성, 콘텐츠를 포함한 그 운영 방식에 대해 보증하지 않으며 책임을 지지 않습니다.
이 문서는 반도체 파운드리, EDA 및 IP 벤더가 Synopsys Cloud와 시스템 간 레벨에서 상호 운용할 수 있도록 지원하는 Synopsys Cloud OpenLink API에 대해 설명합니다. 구체적으로 벤더는 Synopsys Cloud 고객의 제품 사용 권한(entitlement)에 대한 정보를 제공할 수 있으며, 고객은 API를 사용하여 벤더에 라이선스를 요청할 수 있습니다. 요청된 라이선스는 Synopsys Cloud에 설치됩니다. 이 문서의 범위는 다음 Synopsys Cloud OpenLink API 기능을 다룹니다.
Synopsys Cloud 고객이 Synopsys Cloud 포털 UI의 "제3자 사용 권한(Third-Party Entitlements)" 페이지로 이동하여고객 선택하고, 벤더를 해당 벤더의 사용 권한을 탐색한 후 최종적으로 라이선스를 요청합니다.Synopsys Cloud 를 통해 해당 고객의 사용 가능한 권한을 가져옵니다. 벤더를 권한 API 엔드포인트벤더를 API 응답은 UI에 표시되는 사용 가능한 권한 목록을 반환합니다.고객 라이선스를 요청할 권한 수량을 선택하고 요청을 제출합니다.Synopsys Cloud 호출합니다. 벤더를 라이선스 API 엔드포인트벤더를 응답으로 라이선스 파일을 제공하며, 이는 다음에 설치됩니다. Synopsys Cloud 라이선스 서버
이 그래픽은 라이선스 흐름을 보여줍니다.
이 섹션의 시퀀스 차트 다이어그램은 다음 흐름의 기본 사항을 보여줍니다.
Synopsys Cloud와의 통합을 위한 API는 OpenAPI v3 표준을 준수하여 지정됩니다. 사양에는 API를 구현하는 데 필요한 모든 세부 정보가 포함되어 있습니다. 이 섹션에서는 사양을 명확히 설명하기 위한 추가 정보를 제공합니다.
이 섹션에서는 Synopsys Cloud OpenLink API의 공통 속성을 제공합니다.
TLS 2.0 이상의 보안 데이터 전송만 https 지원됩니다.Content-Type: application/json 요청이 지원됩니다.OAUTH2 그리고 API 키기반 인증이 지원됩니다.각 공급업체는 수동 온보딩 흐름을 통해 Synopsys Cloud에 권한(Entitlement) API를 등록합니다. 공급업체 측에서 고객 식별에 사용될 고객별 세부 정보는 상호 협의하에 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
고객 은(는) 다음 항목을 통해 식별됩니다. 벤더를 다음을 통해 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
}
...
]
}
위의 필수 매개변수에 지정된 값은 이후 속성 아래에 제공됩니다. 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 키에 대한 헤더와 값을 제공해야 합니다.
다음에 대한 Swagger OpenAPI 사양을 참조하십시오.
ApiKeyAuthInfo
필요한 온보딩 정보의 예시는 ApiKeyAuthInfo 다음과 같습니다:
{
"header":"x-api-key",
"value":"9114dd77-912e-4179-a8c5-0a8de9dd44cc"
}
Synopsys Cloud 서비스 시작 시, 다음 예시와 같이 권한(Entitlement) API 및 라이선스 생성 API에 대한 각 요청의 헤더에 API 키를 제공합니다:
{
"headers": { "x-api-key":"9114dd77-912e-4179-a8c5-0a8de9dd44cc" }
}
다음에 따른 투-레그(two-legged) OAuth2.0 기반 인증의 경우, RFC 6749 API 온보딩을 위해 인증 URL, 클라이언트 ID 및 클라이언트 시크릿이 벤더를 에서 요구됩니다. 이러한 매개변수에 추가적인 정적 매개변수를 추가하여 POST 요청 본문(body)에 병합할 수 있습니다.
다음에 대한 Swagger OpenAPI 사양을 참조하십시오.
Oauth2ClientInfo
필요한 온보딩 정보의 예시는 Oauth2ClientInfo 는 여기에 나와 있습니다:
{
"url": "https://vendor.com/api/oauth2/token",
"header": {
"x-my-header": "xyz"
},
"staticBody": {
"origin": "synopsys"
},
"clientId": "6779ef20e75817b79602",
"clientSecret": "dl9aUnVyOWdtQ3gxTTlobGU5N2ZWQUd5amdCcUsya2hWdVlMZmZOLWVOZw=="
}
권한 API를 통해 Synopsys Cloud 특정 벤더를 에 대해 고객.
다음 값들이 본문 매개변수로 인코딩된 상태로 Synopsys Cloud 에서 POST 요청이 전송됩니다:
SWAGGER: 관련
EntitlementsRequestDto:
{
"customer": {
"name": "Big Chip Semi",
"dunsNumber": "1232234345",
"synopsysCustomerId": "5a8649c7-129e-447b-afb2-77b778e66ac3",
"vendorCustomerIdentification":{
"sideId": "32668"
}
}
}
이 정보는 벤더를 에서 고객을(를) 식별하는 데 사용됩니다. vendorCustomerIdentification 속성은 공급업체 API 온보딩 과정에서 Synopsys Cloud 에 등록됩니다.
에서 호출되면, 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
}
배열에 포함될 수 있는 항목의 세부 정보는 제공합니다 에 설명되어 있습니다. 다음 섹션. 모든 라이선스를 동일한 엔드포인트에서 제공할 수 있는 경우 벤더를, 배열에는 하나의 항목만 포함될 수 있습니다. 각 항목에는 단일 라이선스 검색 엔드포인트를 통해 라이선스를 검색할 수 있는 모든 권한이 나열됩니다. 서로 다른 엔드포인트가 필요한 경우, 서로 다른 엔드포인트 구성을 가진 여러 항목을 제공할 수 있습니다.
이 항목 유형은 다음에서 사용됩니다. 벤더를 모든 라이선스 권한을 노출하고 다음을 허용합니다. Synopsys Cloud 고객 라이선스를 요청합니다.
고객의 Synopsys Cloud 내 라이선스 서버.벤더를벤더를 후속 라이선스 검색 엔드포인트에서.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"
},
},
}
]
}
각 권한 항목에는 다음 내용이 포함되어야 합니다.
제목설명, 최대 가용 수량 최대 수량, 라이선스 기간 종료일 라이선스 기간 종료일보조.라이선스 요청 시, 제목 그리고 보조 개체가 요청된 수량과 함께 최대 수량 공급업체 라이선스 생성 엔드포인트로 제공됩니다.
UI에서 요청된 수량을 구성한 후, 벤더를 라이선스를 요청하는 엔드포인트가 Synopsys Cloud에서 호출됩니다. 요청에 대한 응답으로, 벤더를 이(가) 요청된 라이선스를 제공하거나 오류를 반환합니다.
벤더를 을(를) 통해 여러 라이선스 파일을 전송할 수 있습니다. 각 라이선스 파일은 Synopsys Cloud 에서 벤더를.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 유형 참조
ProvideLicenseResponse
동기식 응답은 HTTP POST 응답 본문의 일부로 라이선스 파일을 직접 제공합니다. 이 응답 유형은 라이선스 파일을 20초 이내에 프로비저닝할 수 있어 HTTP 시간 초과를 방지할 수 있는 경우에 사용됩니다.
동기식 응답은 페이로드에서 downloadType (으)로 설정된 속성 "Sync" 을(를) 통해 나타납니다. 속성 데이터 은(는) filename 및 하나 이상의 라이선스에 대한 유형과 함께 데이터를 수용할 수 있습니다. 라이선스의 경우 속성 fileType 은(는) 아래 예시와 같이 "License" (으)로 설정해야 합니다.
{
"files": [
{
"fileName": "lic_vendor_tool.lic",
"fileType": "License",
"data": "<Buffer 48 61 6c 6c 6f>",
"downloadType": "Sync"
}
]
}
파일 속성 데이터 에는 버퍼 형태의 Base64 인코딩된 라이선스 파일이 포함됩니다. 순수 자바스크립트에서의 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에는 추가 오류 정보(예: 개별 매개변수에 대한 특정 오류)가 포함될 수 있습니다.
다음 코드는 JavaScript(Node.js)를 사용하여 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}`)
})