API Key
- Print
- PDF
API Key
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Create a apiKey
URL
POST https://apigateway.apigw.ntruss.com/api/v1/api-keys
Request Parameter
- None
Request Body
{
"apiKeyDescription" : "apiKeyDescription",
"apiKeyName" : "apiKeyName"
}
Response Code
- 201
Response Body
{
"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"
}
}
Delete a api key
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
Request Body
- None
Response Code
- 204
Response Body
- None
Search list of api key
URL
GET https://apigateway.apigw.ntruss.com/api/v1/api-keys
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
offset | query string | N | Long | Offset Min: 0 Max: 9,223,372,036,854,775,807 |
limit | query string | N | Long | Limit Min: 1 Max: 9,223,372,036,854,775,807 |
apiKeyName | query string | N | String | Api Key Name Length(Min/Max): 0/20 |
Request Body
- None
Response Code
- 200
Response Body
{
"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"
} ]
}
Search a api key
URL
GET https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
Request Body
- None
Response Code
- 200
Response Body
{
"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"
}
Search associate product list by api key
URL
GET https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/products
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
offset | query string | N | Long | Offset Min: 0 Max: 9,223,372,036,854,775,807 |
limit | query string | N | Long | Limit Min: 1 Max: 9,223,372,036,854,775,807 |
Request Body
- None
Response Code
- 200
Response Body
{
"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"
} ]
}
Regenerate api key
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
Request Body
{
"keyType" : "PRIMARY"
}
Response Code
- 200
Response Body
{
"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"
}
}
Search ApiKey list with Subscribe Status
URL
POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/search
Request Parameter
- None
Request Body
{
"offset" : 6,
"productId" : "productId",
"limit" : 0,
"apiKeyName" : "apiKeyName",
"statusSet" : [ "REQUEST" ]
}
Response Code
- 200
Response Body
{
"total" : 0,
"apiKeys" : [ {
"apiKeyDescription" : "apiKeyDescription",
"apiKeyId" : "apiKeyId",
"apiKeyName" : "apiKeyName",
"disabled" : true,
"permission" : "permission",
"actionName" : "actionName",
"status" : "REQUEST"
} ]
}
Search product subscription detail by product & apiKey (Own api key)
URL
GET https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id Length(Min/Max): 0/10 |
offset | query string | N | Long | Offset Min: 0 Max: 9,223,372,036,854,775,807 |
limit | query string | N | Long | Limit Min: 1 Max: 9,223,372,036,854,775,807 |
apiId | query string | N | String | Api Id Length(Min/Max): 0/10 |
stageId | query string | N | String | Stage Id Length(Min/Max): 0/10 |
productId | query string | Y | String | Product Id Length(Min/Max): 0/10 |
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"
} ]
}
}
Subscribe product
URL
POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscribe
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
Request Body
{
"productId" : "productId"
}
Response Code
- 200
Response Body
- None
Unsubscribe product
URL
POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/unsubscribe
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
Request Body
{
"productId" : "productId"
}
Response Code
- 200
Response Body
- None
Update a api key's attributes
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
apiKeyId | path | Y | String | Api Key Id |
Request Body
{
"isEnabled" : true,
"apiKeyDescription" : "apiKeyDescription",
"apiKeyName" : "apiKeyName"
}
Response Code
- 200
Response Body
{
"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"
}
}
Was this article helpful?