Product 생성

사용자가 지정한 조건에 따라 Product를 생성합니다.

요청

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

메서드	URI
POST	/api/v1/products

요청 헤더

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

요청 구문

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

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

요청 바디

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

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

요청 예시

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

curl --location --request POST 'https://apigateway.apigw.fin-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",
    "zoneCode" : "PRIVATE"
}'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

{
    "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": "FIN",
        "zoneCode": "PRIVATE"
    }
}

Documentation Index