Product 목록 조회

전체 계정의 Product를 대상으로 사용자가 지정한 조건을 만족하는 Product 목록을 조회합니다.

요청

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

메서드	URI
POST	/api/v1/published-products/search

요청 헤더

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

요청 구문

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

{
    "subscribed" : true,
    "publisherId" : "publisherId",
    "offset" : 6,
    "limit" : 0,
    "productName" : "productName",
    "productType" : [ "MY" ]
}

요청 바디

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

필드	타입	필수 여부	설명
`subscribed`	Boolean	Optional	Publishd Product의 구독 여부 `true` \| `false` `true`: 구독함 `false`: 구독 안 함
`publisherId`	String	Optional	게시된 API의 Tenant ID
`offset`	Long	Optional	응답 데이터의 시작 지점 0~9,223,372,036,854,775,807 `limit`과 함께 페이지네이션 구현에 사용
`limit`	Long	Optional	응답 데이터의 최대 수 1~9,223,372,036,854,775,807 `offset`과 함께 페이지네이션 구현에 사용
`productName`	String	Optional	Product 이름 0~100자
`productType`	Array	Optional	Product 유형 `MY` \| `NCP` \| `OTHERS` `MY`: 내 Product `NCP`: NCP Product `OTHERS`: 이외 Product

요청 예시

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

curl --location --request POST 'https://apigateway.apigw.fin-ntruss.com/api/v1/published-products/search' \
--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 '{
    "offset" : 6,
    "limit" : 1,
    "productName" : "product"
}'

응답

응답 형식을 설명합니다.

응답 구문

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

{
    "initialCount" : 0,
    "productPage" : {
        "total" : 6,
        "content" : [ {
            "subscriptionCode" : "PROTECTED",
            "subscribed" : true,
            "domainCode" : "domainCode",
            "productId" : "productId",
            "tenantId" : "tenantId",
            "productDescription" : "productDescription",
            "productName" : "productName",
            "zoneCode" : "PUBLIC"
        } ]
    }
}

응답 상태 코드

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

응답 예시

응답 예시는 다음과 같습니다.

{
    "productPage": {
        "content": [
            {
                "productId": "***pxks***",
                "tenantId": "***3f2489612436793577e878e69e***",
                "productName": "product2",
                "productDescription": "여러 개의 API를 그룹핑하여 관리하기 위한 단위",
                "subscribed": false,
                "subscriptionCode": "PUBLIC",
                "domainCode": "FIN",
                "zoneCode": "PRIVATE"
            }
        ],
        "total": 28
    },
    "initialCount": 780
}

Documentation Index