Product

Modify usage_plan associated with apiKeyRelation

URL

PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/{api-key-id}/stages/{stage-id}

Request Parameter

Request Body

{
  "usagePlanId" : "usagePlanId"
}

Response Code

• 204

Response Body

• None

Create a product

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products

Request Parameter

• None

Request Body

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

Response Code

• 201

Response Body

{
  "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"
  }
}

Delete a product

URL

DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}

Request Parameter

Request Body

• None

Response Code

• 204

Response Body

• None

Get self or published product

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}

Request Parameter

Request Body

• None

Response Code

• 200

Response Body

{
  "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"
  }
}

Get my product

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products

Request Parameter

Request Body

• None

Response Code

• 200

Response Body

{
  "initialCount" : 0,
  "productPage" : {
    "total" : 6,
    "content" : [ {
      "invokeId" : "invokeId",
      "domainCode" : "domainCode",
      "productId" : "productId",
      "isPublished" : true,
      "modifier" : "modifier",
      "permission" : "permission",
      "productName" : "productName",
      "hasDeployedStage" : true,
      "subscriptionCode" : "PROTECTED",
      "isDeleted" : true,
      "modTime" : "2000-01-23T04:56:07.000+00:00",
      "tenantId" : "tenantId",
      "disabled" : true,
      "productDescription" : "productDescription",
      "actionName" : "actionName"
    } ]
  }
}

Modify a product

URL

PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}

Request Parameter

Request Body

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

Response Code

• 204

Response Body

• None

Search api keys list by product

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/search

Request Parameter

Request Body

{
  "apiKeyValue" : "apiKeyValue",
  "offset" : 6,
  "limit" : 0,
  "apiKeyId" : "apiKeyId",
  "statusSet" : [ "REQUEST" ]
}

Response Code

• 200

Response Body

{
  "apiKeyPage" : {
    "total" : 0,
    "content" : [ {
      "domainCode" : "domainCode",
      "regTime" : "2000-01-23T04:56:07.000+00:00",
      "secondaryKey" : "secondaryKey",
      "modTime" : "2000-01-23T04:56:07.000+00:00",
      "apiKeyId" : "apiKeyId",
      "apiKeyName" : "apiKeyName",
      "primaryKey" : "primaryKey",
      "status" : "REQUEST"
    } ]
  }
}

Search a product's document ( api document list with stages ) by product

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/document

Request Parameter

Request Body

• None

Response Code

• 200

Response Body

{
  "apiPage" : {
    "total" : 6,
    "content" : [ {
      "apiName" : "apiName",
      "domainCode" : "domainCode",
      "stages" : [ {
        "deployedStageDeploymentNo" : 0,
        "stageName" : "stageName",
        "host" : "host",
        "stageId" : "stageId"
      } ],
      "apiDescription" : "apiDescription",
      "apiId" : "apiId"
    } ]
  }
}

Search a product's overview

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/overview

Request Parameter

Request Body

• None

Response Code

• 200

Response Body

{
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "methodsCount" : 2,
    "stages" : [ {
      "deployedStageDeploymentNo" : 0,
      "stageName" : "stageName",
      "host" : "host",
      "stageId" : "stageId"
    } ],
    "apiId" : "apiId"
  } ],
  "apiKeyCountInfo" : {
    "request" : 5,
    "total" : 5,
    "rejected" : 1,
    "accepted" : 0,
    "denied" : 6
  }
}

Search product subscription detail by product & apiKey (Own product)

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/subscription-detail

Request Parameter

Request Body

• None

Response Code

• 200

Response Body

{
  "apiKeyRelations" : {
    "total" : 5,
    "content" : [ {
      "apiName" : "apiName",
      "domainCode" : "domainCode",
      "monthlyUsage" : 5,
      "usagePlanId" : "usagePlanId",
      "monthCallCount" : 1,
      "apiKeyId" : "apiKeyId",
      "apiKeyName" : "apiKeyName",
      "usagePlanName" : "usagePlanName",
      "dailyUsage" : 0,
      "regTime" : "2000-01-23T04:56:07.000+00:00",
      "stageName" : "stageName",
      "modTime" : "2000-01-23T04:56:07.000+00:00",
      "dayCallCount" : 6,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ]
  }
}

Set subscription status

URL

PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/{api-key-id}

Request Parameter

Request Body

{
  "status" : "ACCEPTED"
}

Response Code

• 204

Response Body

• None