API Key

印刷する
共有
PDF

API Key

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

API Keyを作成

URL

POST https://apigateway.apigw.ntruss.com/api/v1/api-keys

リクエストパラメータ

なし

リクエストボディ

{
  "apiKeyDescription" : "apiKeyDescription",
  "apiKeyName" : "apiKeyName"
}

応答コード

応答ボディ

{
  "apiKey" : {
    "domainCode" : "domainCode",
    "secondaryKey" : "secondaryKey",
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "isEnabled" : true,
    "modifier" : "modifier",
    "tenantId" : "tenantId",
    "apiKeyDescription" : "apiKeyDescription",
    "apiKeyId" : "apiKeyId",
    "apiKeyName" : "apiKeyName",
    "primaryKey" : "primaryKey"
  }
}

API Keyを削除

URL

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

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id

リクエストボディ

なし

応答コード

応答ボディ

なし

API Keyリスト検索

URL

GET https://apigateway.apigw.ntruss.com/api/v1/api-keys

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
apiKeyName	query string	N	String	Api Key Name 長さ（最大/最小）：0 / 20

リクエストボディ

なし

応答コード

応答ボディ

{
  "initialCount" : 0,
  "total" : 6,
  "apiKeys" : [ {
    "domainCode" : "domainCode",
    "secondaryKey" : "secondaryKey",
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "isEnabled" : true,
    "modifier" : "modifier",
    "tenantId" : "tenantId",
    "apiKeyDescription" : "apiKeyDescription",
    "apiKeyId" : "apiKeyId",
    "apiKeyName" : "apiKeyName",
    "primaryKey" : "primaryKey"
  } ]
}

API Key照会

URL

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

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id

リクエストボディ

なし

応答コード

応答ボディ

{
  "domainCode" : "domainCode",
  "secondaryKey" : "secondaryKey",
  "modTime" : "2000-01-23T04:56:07.000+00:00",
  "isEnabled" : true,
  "modifier" : "modifier",
  "tenantId" : "tenantId",
  "apiKeyDescription" : "apiKeyDescription",
  "apiKeyId" : "apiKeyId",
  "apiKeyName" : "apiKeyName",
  "primaryKey" : "primaryKey"
}

API Keyが結合されたproduct照会

URL

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

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807

リクエストボディ

なし

応答コード

応答ボディ

{
  "total" : 0,
  "apiKeyRelateProductDtos" : [ {
    "publisherId" : "publisherId",
    "regTime" : "2000-01-23T04:56:07.000+00:00",
    "productId" : "productId",
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "productDescription" : "productDescription",
    "productName" : "productName",
    "status" : "REQUEST"
  } ]
}

API Keyを再生成

URL

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

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id

リクエストボディ

{
  "keyType" : "PRIMARY"
}

応答コード

応答ボディ

{
  "apiKey" : {
    "domainCode" : "domainCode",
    "secondaryKey" : "secondaryKey",
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "isEnabled" : true,
    "modifier" : "modifier",
    "tenantId" : "tenantId",
    "apiKeyDescription" : "apiKeyDescription",
    "apiKeyId" : "apiKeyId",
    "apiKeyName" : "apiKeyName",
    "primaryKey" : "primaryKey"
  }
}

API Key照会

URL

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

リクエストパラメータ

なし

リクエストボディ

{
  "offset" : 6,
  "productId" : "productId",
  "limit" : 0,
  "apiKeyName" : "apiKeyName",
  "statusSet" : [ "REQUEST" ]
}

応答コード

応答ボディ

{
  "total" : 0,
  "apiKeys" : [ {
    "apiKeyDescription" : "apiKeyDescription",
    "apiKeyId" : "apiKeyId",
    "apiKeyName" : "apiKeyName",
    "disabled" : true,
    "permission" : "permission",
    "actionName" : "actionName",
    "status" : "REQUEST"
  } ]
}

API Keyを購読照会

URL

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

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id 長さ（最大/最小）：0 / 10
offset	query string	N	Long	Offset 最小：0 最大：9,223,372,036,854,775,807
limit	query string	N	Long	Limit 最小：1 最大：9,223,372,036,854,775,807
apiId	query string	N	String	Api Id 長さ（最大/最小）：0 / 10
stageId	query string	N	String	Stage Id 長さ（最大/最小）：0 / 10
productId	query string	Y	String	Product Id 長さ（最大/最小）：0 / 10

リクエストボディ

なし

応答コード

応答ボディ

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

product購読

URL

POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscribe

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id

リクエストボディ

{
  "productId" : "productId"
}

応答コード

応答ボディ

なし

product購読解除

URL

POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/unsubscribe

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id

リクエストボディ

{
  "productId" : "productId"
}

応答コード

応答ボディ

なし

API Key修正

URL

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

リクエストパラメータ

名前	位置	必須かどうか	タイプ	説明
apiKeyId	path	Y	String	Api Key Id

リクエストボディ

{
  "isEnabled" : true,
  "apiKeyDescription" : "apiKeyDescription",
  "apiKeyName" : "apiKeyName"
}

応答コード

応答ボディ

{
  "apiKey" : {
    "domainCode" : "domainCode",
    "secondaryKey" : "secondaryKey",
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "isEnabled" : true,
    "modifier" : "modifier",
    "tenantId" : "tenantId",
    "apiKeyDescription" : "apiKeyDescription",
    "apiKeyId" : "apiKeyId",
    "apiKeyName" : "apiKeyName",
    "primaryKey" : "primaryKey"
  }
}

この記事は役に立ちましたか?

What's Next

Authorizer

API Keyを作成
API Keyを削除
API Keyリスト検索
API Key照会
API Keyが結合されたproduct照会
API Keyを再生成
API Key照会
API Keyを購読照会
product購読
product購読解除
API Key修正

タグ

API Gateway