Published Product
    • PDF

    Published Product

    • PDF

    Article Summary

    Get all product

    URL

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

    Request Parameter

    • None

    Request Body

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

    Response Code

    • 200

    Response Body

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

    Get self or published api document

    URL

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

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "modifier" : "modifier",
      "tenantId" : "tenantId",
      "apiId" : "apiId",
      "documentMd" : "documentMd"
    }
    

    Get self or published product without permission check (for published apis page)

    URL

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

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10

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

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

    URL

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

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    offsetquery stringNLongOffset
    Min: 0
    Max: 9,223,372,036,854,775,807
    limitquery stringNLongLimit
    Min: 1
    Max: 9,223,372,036,854,775,807
    apiNamequery stringNStringApi Name
    Length(Min/Max): 0/20

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

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.