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"
}
응답 코드
- 201
응답 바디
{
"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 |
요청 바디
- 없음
응답 코드
- 204
응답 바디
- 없음
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 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"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 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"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 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"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",
"isSelfProduct": true
} ]
}
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"
}
응답 코드
- 200
응답 바디
{
"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" ]
}
응답 코드
- 200
응답 바디
{
"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 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"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"
}
응답 코드
- 200
응답 바디
- 없음
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"
}
응답 코드
- 200
응답 바디
- 없음
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"
}
응답 코드
- 200
응답 바디
{
"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"
}
}
이 문서가 도움이 되었습니까?