API 키 - Entity Enricher 문서

API 키

Entity Enricher에 대한 프로그래밍 방식 액세스를 위한 API key를 생성하세요. 서비스 간 통합, CI/CD 파이프라인, 자동화된 워크플로에는 organization access key를 사용하세요.

키 유형

Entity Enricher는 두 가지 유형의 API 키를 지원하며, 각각 서로 다른 사용 사례에 적합합니다:

추천

Organization 접근 키

사용자 계정에 연결되지 않고 자체 역할을 가진 독립 실행형 키입니다. 서비스 간 통합에 가장 적합한 선택입니다.

  • 자체 역할(owner, editor 또는 operator)을 가짐
  • 사용자 계정 변경의 영향을 받지 않습니다
  • 조직으로 범위 지정됨
  • 생성하려면 소유자 역할이 필요합니다

레거시 사용자 키

특정 사용자 계정에 연결된 키입니다. 생성자의 역할을 상속하며 사용자 계정 변경의 영향을 받습니다.

  • 생성한 사용자의 역할 상속
  • 사용자가 비활성화되면 키가 작동을 멈춥니다
  • 인증된 모든 사용자가 생성할 수 있습니다

키 형식 및 보안

형식:ent_a1b2c3d4e5f6g7h8

키는 ent_ 접두사 뒤에 무작위 바이트가 붙습니다. 전체 키는 생성 시점에 한 번만 표시되며 나중에 다시 조회할 수 없습니다.

액세스 키(Entity Enricher의 API 호출용)는 데이터베이스에 SHA256 해시로 저장되므로, 데이터베이스에 접근하더라도 원래 키를 복구할 수 없습니다. 식별을 위해 처음 12자(접두사)만 평문으로 저장됩니다.

제공업체 키(Anthropic, OpenAI 같은 LLM API 키)는 Fernet 대칭 암호화(AES-128-CBC + HMAC)를 사용하여 저장 시 암호화됩니다. LLM 제공업체와 인증하려면 런타임에 복호화할 수 있어야 합니다. 마지막 4자만 일반 텍스트로 저장됩니다.

API 키 생성 중

애플리케이션의 API Keys 페이지에서 또는 REST API를 통해 프로그래밍 방식으로 key를 생성하세요:

키 구성

필드설명
이름식별을 위한 설명적 이름(예: "CI/CD Pipeline", "n8n Integration")
역할권한 수준: owner, editor 또는 operator. 키가 액세스할 수 있는 항목을 결정합니다.
범위읽기, 쓰기 또는 둘 다입니다. 키가 데이터를 수정할 수 있는지 아니면 읽기만 할 수 있는지 제어합니다.
만료선택적 만료일입니다. 만료일이 없는 키는 폐기될 때까지 유지됩니다.

API Key 사용

모든 요청에 X-API-Key 헤더로 API 키를 전송하세요:

curl -H "X-API-Key: ent_your_key_here" \
     https://your-instance.example.com/api/enrichment/options

인증 방법

메서드헤더사용 사례
API 키X-API-Key: ent_...서비스 간 통신, CI/CD, 자동화
Bearer 토큰Authorization: Bearer <jwt>웹 클라이언트, 대화형 세션

역할별 엔드포인트 접근

API 키의 역할에 따라 접근할 수 있는 엔드포인트가 결정됩니다:

엔드포인트 범주최소 역할
보강 (단일, 배치)연산자
레코드(목록, 상세, 삭제)연산자
스키마 (읽기)연산자
스키마 (생성, 편집, 삭제)편집기
융합연산자
프로바이더 정보연산자
비용 분석연산자
API 키 관리소유자
사용자 관리소유자

키 관리

API Keys 페이지는 사용 통계와 함께 모든 조직 키의 전체 목록을 제공합니다:

사용량 보기각 키의 마지막 사용 시간과 총 사용 횟수를 확인합니다
역할 업데이트조직 액세스 키의 역할을 변경합니다(소유자만 가능)
해지키를 영구적으로 비활성화합니다. 해지된 키는 다시 활성화할 수 없습니다.
만료7일 이내에 만료되는 키는 표시됩니다. 만료된 키는 자동으로 거부됩니다.

프로바이더 키 vs. 액세스 키

API Keys 페이지에는 서로 다른 용도의 여러 탭이 있습니다:

프로바이더 키

독립적인 청구를 위한 조직의 LLM 제공업체 API 키(Anthropic, OpenAI 등)입니다. 제공업체별로 여러 키를 지원하며 자동 LRU 순환을 제공합니다. BYOK 시스템에 대해서는 모델 및 가격을 참조하세요.

프로바이더 키는 Fernet 대칭 암호화(HMAC 인증이 포함된 AES-128-CBC)를 사용하여 저장 시 암호화됩니다. LLM API 호출을 수행할 때 런타임에만 복호화됩니다. 표시 목적으로 마지막 4자만 평문으로 저장됩니다.

글로벌 키

관리자가 관리하는 시스템 전역 LLM 제공자 키입니다. 조직 키가 없을 때 대체로 사용됩니다. LRU 순환 방식으로 제공자당 여러 키를 지원하며 영구적 실패 시 자동으로 비활성화합니다.

Organization 접근 키

Entity Enricher 자체 API에 액세스하기 위한 키입니다. 외부 시스템이 강화, 스키마, 레코드 및 기타 엔드포인트를 프로그래밍 방식으로 호출하는 데 사용합니다. 엔드포인트 문서는 API 참조를 확인하세요.

다음 단계