リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/products

リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。

リクエスト構文

リクエスト構文は次の通りです。

{
    "subscriptionCode" : "PROTECTED",
    "description" : "description",
    "productName" : "productName"
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`subscriptionCode`	String	Required	作成する Productのサブスクリプション方法 `PUBLIC` \| `PROTECTED` `PUBLIC`: APIを承認なしで誰でも使用可能 `PROTECTED`: APIを使用するには、公開者の承認が必要
`description`	String	Optional	作成する Productの説明 0~300文字
`productName`	String	Required	作成する Productの名前 1~100文字

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "subscriptionCode" : "PROTECTED",
    "description": "test",
    "productName" : "product001"
}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
    "product" : {
        "invokeId" : "invokeId",
        "domainCode" : "domainCode",
        "productId" : "productId",
        "isPublished" : true,
        "modifier" : "modifier",
        "permission" : "permission",
        "productName" : "productName",
        "subscriptionCode" : "PROTECTED",
        "isDeleted" : true,
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "tenantId" : "tenantId",
        "disabled" : true,
        "productDescription" : "productDescription",
        "actionName" : "actionName",
        "zoneCode" : "PUBLIC"
  }
}

レスポンスステータスコード

API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "product": {
        "productId": "***ghj3***",
        "invokeId": "***ghj3***",
        "tenantId": "***e230cebc1402ba89b148896951***",
        "productName": "product000",
        "productDescription": "test",
        "isPublished": false,
        "subscriptionCode": "PROTECTED",
        "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
        "isDeleted": false,
        "modTime": "2024-05-07T01:53:41Z",
        "domainCode": "PUB",
        "zoneCode": "PUBLIC"
    }
}

この記事は役に立ちましたか?

リクエスト
レスポンス