Product 수정

사용자가 지정한 조건에 따라 Product의 정보를 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
PATCH	/api/v1/products/{product-id}

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`product-id`	String	Required	수정할 Product ID 0~10자 Product 목록 조회 참조

요청 구문

요청 구문은 다음과 같습니다.

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`subscriptionCode`	String	Required	수정할 구독 방식 `PUBLIC` \| `PROTECTED` `PUBLIC`: API를 승인 없이 누구나 사용 가능 `PROTECTED`: API를 사용하려면 게시자의 승인 필요
`description`	String	Optional	수정할 Product 설명 0~300자
`productName`	String	Required	수정할 Product 이름 0~100자 수정하지 않으려면 기존 Product 이름 입력
`zoneCode`	String	Optional	API Gateway Zone `PRIVATE` \| `PUBLIC` `PRIVATE`: 금융 VPC 또는 SSL VPN을 통해서만 접근 가능 `PUBLIC`: 어디에서든 접근 가능

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PATCH 'https://apigateway.apigw.fin-ntruss.com/api/v1/products/***681e***' \
--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" : "PUBLIC",
    "description" : "product002",
    "productName" : "product002",
    "zoneCode": "PRIVATE"
}'

응답

응답 형식을 설명합니다.

응답 상태 코드

API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 API Gateway 응답 상태 코드를 참조해 주십시오.

Documentation Index