API Key 관리¶

Guance는 Open API 호출을 통해 워크스페이스의 데이터를 가져오고 업데이트하는 것을 지원합니다. API를 호출하기 전에 먼저 API Key를 생성하여 인증 자격 증명으로 사용해야 합니다.

API Key는 Guance Open API에 접근하기 위한 핵심 자격 증명으로, 요청 헤더의 DF-API-KEY 필드를 통해 인증을 수행하고 요청이 속한 워크스페이스를 확인합니다.

Open API의 상세 인터페이스 목록은 Open API를 참조하세요.

전제 조건¶

• Guance 워크스페이스의 관리자 또는 Owner 권한이 있어야 API Key를 생성하고 관리할 수 있습니다.
• 호출하려는 API 인터페이스에 필요한 권한 범위를 이해하여 역할을 올바르게 구성해야 합니다.

API Key 생성¶

작업 단계¶

1. Guance 워크스페이스로 이동하여 왼쪽 탐색 모음에서 관리 > API Key 관리를 클릭합니다.
2. 오른쪽 상단의 Key 생성 버튼을 클릭합니다.

3. 팝업 대화 상자에서 다음 정보를 구성합니다.

   • 이름: API Key의 식별하기 쉬운 이름을 설정합니다. 최대 길이는 50자입니다.
   • 역할: 이 API Key와 연결할 역할을 선택하여 권한 범위를 결정합니다.
   • 비고: Key의 용도를 식별합니다.

4. 확인합니다.

역할 및 권한 규칙¶

1. Owner 레벨 API Key 특별 제한

• Owner 계정만 볼 수 있으며 1개만 생성 가능합니다.
• 생성 후 목록의 첫 번째에 기본적으로 고정되어 표시됩니다.
• 다른 역할(Administrator 포함)에게는 완전히 보이지 않습니다.

2. 다중 역할 권한 병합

• 하나의 API Key에 여러 역할을 선택한 경우 최종 권한은 선택한 역할 권한의 합집합입니다.
• 최소 권한 원칙을 준수하여 필요한 역할만 선택하는 것을 권장합니다.

API Key 획득 및 사용¶

생성 성공 후 API Key 목록 페이지에서 API Key 상세 정보로 이동하면 시스템이 다음 정보를 표시합니다.

• Key ID: API Key의 고유 식별자
• Key(비밀키): API 요청을 위한 인증 자격 증명

이 외에도 필요에 따라 현재 API Key의 이름과 역할을 수정할 수 있습니다.

획득¶

API 인증 방식¶

모든 Open API 요청은 HTTP Header를 통해 인증됩니다.