초기화 및 조회¶
GET /api/v1/workspace/inner_accesskey/{workspace_uuid}/get
개요¶
워크스페이스 내장 Owner 시스템 키를 조회하며, 키가 없으면 자동으로 초기화합니다.
호출 전 준비 및 사용 단계¶
메서드는 GET이지만 이 API는 w 권한이 필요하고 키를 생성할 수 있으므로 읽기 전용 탐지 용도로 사용할 수 없습니다. 먼저 워크스페이스 목록에서 활성 워크스페이스를 선택합니다. 활성 inner sys 키가 이미 있으면 기존 자격 증명을 반환하고, 없으면 이름이 inner이고 isSystem=1, isOwnerRole=1인 시스템 키를 생성한 뒤 평문 AK/SK를 반환합니다. 초기화 없이 조회만 하려면 내장 키 목록을 사용합니다. 이 API는 기존 자격 증명을 갱신하지 않으며, 성공 응답은 고정된 10개 필드만 반환하고 역할/권한 상세나 전체 엔터티는 포함하지 않습니다.
라우트 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| workspace_uuid | string | Y | 워크스페이스 UUID이며, API Key 레코드 UUID나 평문 AK/SK가 아닙니다. 예시: wksp_example001획득 또는 입력 방법: 워크스페이스 목록의 content.data[].uuid에서 가져오고 사이트와 활성 상태를 확인합니다. |
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 원본 경로 및 요청 본문 서명 버전이며, 이를 생략하고 이 페이지의 알고리즘을 계속 사용할 수 없습니다. 예시: v20240417획득 또는 입력 방법: 이 페이지의 예시는 이 고정 버전을 사용하며 예시 서명 알고리즘과 함께 동작합니다. |
|
| X-Df-Access-Key | string | Y | 이 모듈의 목록은 r 또는 w 권한을 사용할 수 있으며, GET 초기화를 포함한 나머지 세 가지는 w 권한이 필요합니다. 예시: <external-access-key>획득 또는 입력 방법: 사이트 관리자가 할당한 External API AK를 사용하며, 워크스페이스 OpenAPI Key는 사용할 수 없습니다. |
| X-Df-Nonce | string | Y | 임시 일련번호이며, 실패 후 재전송 시에도 새 값을 생성하고 서명을 다시 계산합니다. 예시: 97d275ee9f774315a7885ba7347acbd9획득 또는 입력 방법: 요청마다 uuid.uuid4().hex를 다시 생성합니다. |
| X-Df-Signature | string | Y | 대문자 메서드, nonce, 원본 전체 경로, timestamp, 원본 UTF-8 요청 본문을 공백으로 연결한 뒤 HMAC-SHA256으로 계산하여 hex 다이제스트를 사용합니다. 예시: <hmac-sha256-hex>획득 또는 입력 방법: External API 서명 인증에 따라 함께 제공된 SK로 계산하며, 전체 실행 가능한 템플릿은 아래와 같습니다. |
| X-Df-Timestamp | string | Y | 사이트에 구성된 서명 유효 시간 범위 내여야 하며, 예시 시간을 재사용할 수 없습니다. 예시: 1785427200획득 또는 입력 방법: 전송 시 str(int(time.time()))로 현재 Unix 초 문자열을 생성합니다. |
매개변수 추가 설명¶
사이트 수준 External API 자격 증명을 사용하며, 인증은 External API 서명 인증을 참조합니다. 목록은 r 또는 w 권한을 허용하고, GET 초기화를 포함한 나머지 세 가지는 w 권한이 필요합니다. 모든 응답은 고권한 자격 증명 평문을 반환할 수 있으므로 일반 프런트엔드 페이지의 마스킹 표시 규칙을 적용해서는 안 됩니다. 예시는 자리 표시자 값을 사용하며, 실제 자격 증명은 안전하게 보관해야 합니다.
요청 예시¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 대상 사이트 주소 및 관리자가 할당한 External API AK/SK로 교체합니다.
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'GET'
path = '/api/v1/workspace/inner_accesskey/wksp_example001/get'
query = {}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
응답¶
HTTP 200, application/json 통합 래퍼이며 비즈니스 결과는 content에 있습니다. External은 declaration을 자동으로 추가하지 않으며, 목록 페이지네이션은 content.pageInfo를 유지합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.uuid | string | API Key 레코드 UUID이며, 호출 자격 증명 ak/sk와 다릅니다. |
| content.createAt | integer | 생성 Unix 초입니다. |
| content.updateAt | integer | 업데이트 Unix 초이며, 아직 수정되지 않은 경우 일반적으로 -1입니다. |
| content.name | string | 내장 Key 이름이며, 초기화 시 inner입니다. |
| content.ak | string | 내장 시스템 Access Key 평문이며 고권한 자격 증명으로 보관합니다. External 서명 AK가 아닙니다. |
| content.sk | string | 내장 시스템 Secret Key 평문이며 고권한 자격 증명으로 보관합니다. External 서명 SK가 아닙니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.businessType | string | 이 모듈은 inner sys 유형만 관리합니다. |
| content.isSystem | integer | 이 모듈은 시스템 내장 Key만 관리하며, 초기화 시 1입니다. |
| content.isOwnerRole | integer | 초기화 시 1이며 Owner 역할 의미를 가집니다. 일반 수동 Owner Key와 별도로 관리됩니다. |
{
"code": 200,
"content": {
"uuid": "wsak_inner_example001",
"ak": "<inner-access-key>",
"sk": "<inner-secret-key>",
"name": "inner",
"businessType": "inner sys",
"workspaceUUID": "wksp_example001",
"isSystem": 1,
"isOwnerRole": 1,
"createAt": 1785427200,
"updateAt": -1
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조합니다.
매개변수가 선언과 일치하지 않으면 공통 요청 오류를 반환합니다. 데이터베이스, 캐시 등 일반적인 내부 예외는 최종적으로 500 ft.InternalServerError로 통합됩니다. 쓰기 요청이 실패하면 먼저 영속 상태와 캐시를 확인해야 하며, 모든 변경이 적용되지 않았다고 보장할 수 없습니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 매개변수 파싱 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 401 | ft.WKSPNotExistOrReleased | 대상 워크스페이스가 존재하지 않거나 활성 status=0이 아님 | 워크스페이스가 존재하지 않음/또는 이미 릴리스됨 | 워크스페이스 목록에서 활성 워크스페이스를 선택하며, 이 API로 삭제된 워크스페이스에 Key를 생성할 수 없습니다. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시 무효화 또는 명시적으로 처리되지 않은 내부 예외 | 내부 오류 | traceId를 저장하고 Key 현재 상태와 실제 호출 결과를 먼저 확인한 후 재시도 여부를 결정합니다. 데이터베이스에 이미 커밋되었을 수 있으므로 오류 응답만으로 변경이 없었다고 판단할 수 없습니다. |