API 키
이 페이지의 내용
API 키를 사용하면 자체 소프트웨어나 BYOK(Bring Your Own Key)를 지원하는 모든 타사 시스템에서 Performance Hub가 게시한 모델을 사용할 수 있습니다. 키는 Settings(톱니바퀴) → Service Access & API Keys에서 관리합니다. 키를 관리하려면 Organisation Administrator여야 합니다.
"BYOK(Bring Your Own Key)를 지원하는 타사 소프트웨어 및 시스템이 Performance Hub에서 게시한 모델에 연결할 수 있도록 API 키를 발급합니다."
그림 1: API 키 목록: 레이블, 마스킹된 키, 상태, 지출 및 한도, 모델, 마지막 사용 및 행 작업
키 목록
| 열 | 의미 |
|---|---|
| Label | 키에 지정한 선택적 이름입니다. |
| Key | 마스킹된 키입니다(예: phk_7Qm2…Xa9LkP). 생성 후에는 전체 비밀 키가 다시 표시되지 않습니다. |
| Status | Active, Provisioning…(새 키를 설정하는 동안 잠시 표시됨) 또는 Disabled(해지됨, 행이 흐리게 표시됨)입니다. |
| Spend / limits | 전체 기간 지출과 키에 설정된 지출 한도 대비 진행 상황입니다. |
| Models | all 또는 키가 제한된 모델 수입니다. |
| Last used | 키가 마지막으로 요청한 시간입니다. |
| Actions | Edit, Rotate, Revoke(또는 Re-activate), Delete입니다. |
Workflows를 사용하는 경우 Workflows 행에는 마스킹된 키 대신 Managed service가 표시됩니다. 키가 하나도 없으면 목록에 *"No API keys yet."*이 표시됩니다.
키 생성
Create key를 클릭합니다. Create API key 창이 열립니다.
그림 2: Create API key 창: 레이블, 연결 유형, 지출 한도, 속도 제한, 모델 제한 및 Guardrails 재정의
| 설정 | 동작 |
|---|---|
| Label (optional) | 키의 이름으로, 보통 키를 사용할 시스템 이름입니다(예: Hotel Concierge App, Clinic Intake Assistant 또는 Booking Website). 레이블을 지정하는 것을 적극 권장합니다. Activity와 Logs에서 사용량은 레이블로 구분됩니다. |
| Connection type | API key: "Generic API keys remain in the API Keys list." External agent: "External agents appear under Connected Services and use this key to authenticate." 키를 생성할 때 설정하며 나중에 변경할 수 없습니다. |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key." Daily limit("Resets at the start of each day (facility timezone)."), Monthly limit("Resets on the 1st of each month (facility timezone)."), Lifetime cap("Total spend over the lifetime of this key. Never resets.")이 있습니다. |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited." Requests / min 및 Tokens / min이 있습니다. |
| Restrict models for this key | "Only the selected models will be usable with this key." 시설에서 활성화된 모델 중에서 선택합니다. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." 켜면 이 키는 시설의 Guardrails 대신 자체 Guardrails 선택("none" 포함)을 사용합니다. Guardrails를 참조하십시오. |
Create key를 클릭합니다.
일회성 비밀 키
새 키는 Copy your API key 대화 상자에 한 번만 표시됩니다.
그림 3: 새 키는 한 번만 표시됩니다. 대화 상자를 닫기 전에 복사하십시오
"전체 키가 표시되는 것은 이번이 유일합니다. 안전한 곳에 보관하세요."
Done을 클릭하기 전에 비밀 키를 비밀 관리자에 복사하십시오. 이 대화 상자가 닫히면 마스킹된 형식만 표시됩니다. 비밀 키를 잃어버린 경우 키를 Rotate하여 새 키를 받으십시오.
키 편집
키의 행(또는 Edit 연필 아이콘)을 클릭하면 Configure API key 창이 열립니다. 생성할 때와 같은 설정(레이블, 지출 한도, 속도 제한, 모델 제한, Guardrails 재정의)이 있습니다.
그림 4: Configure API key 창
변경 사항은 저장 후 곧바로 적용됩니다. 키에 일별/월별 한도가 있으면 행에 한도 대비 사용량(Today, This month, Lifetime)이 표시되며, 한도에 도달하면 Limit reached 배지가 표시됩니다.
키 수명 주기: 순환, 해지, 삭제
각 작업에는 어떤 일이 일어나는지 정확히 알려 주는 확인 대화 상자가 있습니다.
| 작업 | 효과 | 확인 문구 |
|---|---|---|
| Rotate | 같은 설정으로 새 비밀 키를 발급하며(한 번만 표시됨), 이전 비밀 키는 즉시 작동을 멈춥니다. | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | 키를 즉시 비활성화하며, 되돌릴 수 있습니다. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | 해지된 키를 복원합니다(같은 비밀 키). | 없음. 즉시 실행됩니다. |
| Delete | 키를 영구적으로 제거합니다. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
그림 5: Delete API key 확인
사용할 작업: 유출이 의심되면 순환하십시오(서비스의 설정과 기록은 유지되며 비밀 키만 업데이트하면 됩니다). 시스템을 일시적으로 중지하려면 해지하십시오. 통합을 영구적으로 없앨 때만 삭제하십시오.
키로 연결하기
키 목록 아래의 Connecting to the API 카드에는 기본 URL과 사용 환경에 맞는 복사하여 붙여 넣을 수 있는 예제 요청이 표시됩니다. SDK 예제와 오류 처리를 포함한 전체 빠른 시작은 애플리케이션 연결을 참조하십시오.