콘텐츠로 건너뛰기

API 키

Ultralytics API 키는 원격 훈련, 추론 및 자동화를 위한 안전한 프로그래매틱 접근을 가능하게 합니다. 다양한 사용 사례에 맞춰 특정 권한을 부여한 범위 지정 키를 생성하세요.

API 키 생성

새 API 키 생성:

  1. 설정 > API 키로 이동하세요
  2. 키 생성
  3. 키 이름을 입력하세요
  4. 권한 범위 선택
  5. 생성하기

키 이름

키에 설명적인 이름을 지정하세요:

  • training-server - 원격 훈련용 기계
  • ci-pipeline - CI/CD 통합을 위해
  • mobile-app - 모바일 애플리케이션용

권한 범위

키 권한을 제한할 범위를 선택하십시오:

범위권한
교육훈련 시작, 스트림 메트릭
모델모델 업로드, 다운로드, 삭제
데이터 세트데이터셋에 접근하고 수정하기
읽다모든 리소스에 대한 읽기 전용 접근 권한
쓰다전체 쓰기 권한
관리자계정 관리 (주의해서 사용하십시오)

최소 권한

필요한 권한만 부여된 키를 생성하십시오. 서로 다른 애플리케이션에는 별도의 키를 사용하십시오.

키 디스플레이

생성 후 키는 한 번 표시됩니다:

키 복사하기

전체 키는 단 한 번만 표시됩니다. 즉시 복사하여 안전하게 보관하십시오. 나중에 다시 불러올 수 없습니다.

키 형식

API 키는 다음 형식을 따릅니다:

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
  • 접두사: ul_ Ultralytics 식별합니다
  • 본문: 40개의 무작위 16진수 문자
  • : 43자

API 키 사용

환경 변수

키를 환경 변수로 설정하세요:

export ULTRALYTICS_API_KEY="ul_your_key_here"
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

코드에서

Python 에서 키를 사용하세요:

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "ul_your_key_here"

HTTP 헤더

API 요청에 키를 포함하십시오:

curl -H "Authorization: Bearer ul_your_key_here" \
  https://platform.ultralytics.com/api/...

원격 교육

키로 메트릭 스트리밍을 활성화하세요.

패키지 버전 요구 사항

플랫폼 통합에는 ultralytics>= 8.4.0 버전이 필요합니다. 하위 버전은 플랫폼과 호환되지 않습니다.

pip install "ultralytics>=8.4.0"
export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo11n.pt data=coco.yaml project=username/project name=exp1

키 관리

보기 키

모든 키는 설정 > API 키에 나열되어 있습니다:

칼럼설명
이름키 식별자
범위할당된 권한
생성됨생성 날짜
마지막 사용가장 최근 사용

키 취소

손상되었거나 더 이상 필요하지 않은 키를 취소하십시오:

  1. 키의 메뉴를 클릭하세요
  2. 취소 선택
  3. 취소 확인

즉시 효력

취소는 즉시 적용됩니다. 해당 키를 사용하는 모든 애플리케이션은 작동이 중단됩니다.

키 재생성

키가 유출된 경우:

  1. 동일한 범위를 가진 새 키 생성
  2. 응용 프로그램을 업데이트하십시오
  3. 기존 키를 취소합니다

보안 모범 사례

  • 키를 환경 변수에 저장하세요
  • 서로 다른 환경에는 별도의 키를 사용하십시오
  • 사용하지 않는 키는 즉시 취소하십시오
  • 최소한의 필수 범위를 사용하십시오
  • 키를 주기적으로 회전시키다

하지 마라

  • 키를 버전 관리에 커밋합니다
  • 애플리케이션 간 키 공유
  • 관리자 권한을 불필요하게 사용하다
  • 애플리케이션 출력에 로그 키 기록
  • 클라이언트 측 코드에 키를 임베드

키 회전

보안을 위해 주기적으로 키를 교체하십시오:

  1. 동일한 범위를 가진 새 키 생성
  2. 새 키를 사용하도록 애플리케이션을 업데이트하십시오
  3. 응용 프로그램이 올바르게 작동하는지 확인하십시오
  4. 기존 키 취소

교대 근무 일정

민감한 애플리케이션의 경우 90일마다 키를 회전하는 것을 고려하십시오.

문제 해결

무효 키 오류

Error: Invalid API key

해결책:

  1. 키가 올바르게 복사되었는지 확인하십시오
  2. 키가 취소되지 않았는지 확인하십시오
  3. 키가 필요한 범위를 갖도록 하십시오
  4. 환경 변수가 설정되었는지 확인하십시오

권한이 거부되었습니다

Error: Permission denied for this operation

해결책:

  1. 키 범위 확인에는 필수 권한이 포함됩니다
  2. 리소스 소유자임을 확인하세요
  3. 올바른 범위를 가진 새 키 생성

속도 제한

Error: Rate limit exceeded

해결책:

  1. 요청 빈도 감소
  2. 지수적 백오프 구현
  3. 한도 증액을 위해 고객지원팀에 문의하세요

FAQ

얼마나 많은 키를 생성할 수 있나요?

API 키에는 엄격한 제한이 없습니다. 다양한 애플리케이션과 환경에 필요한 만큼 자유롭게 생성하세요.

키에는 유효기간이 있나요?

키가 자동으로 만료되지 않습니다. 키는 취소될 때까지 유효합니다. 보안을 위해 키 회전 정책을 도입하는 것을 고려하십시오.

키 생성 후 확인할 수 있나요?

아니요, 전체 키는 생성 시 단 한 번만 표시됩니다. 분실 시 새 키를 생성하고 기존 키를 취소하십시오.

키(키보드)는 지역별로 다를까요?

키(Key)는 모든 지역에서 작동하지만, 액세스할 수 있는 데이터는 해당 계정의 지역에서만 가능합니다.

팀원들과 키를 공유할 수 있나요?

더 나은 방법: 각 팀원이 자신만의 키를 생성하도록 합니다. 이를 통해 다음과 같은 이점이 있습니다:

  • 개인 활동 추적
  • 선택적 취소
  • 적절한 접근 제어


📅 생성 0 일 전 ✏️ 업데이트 0일 전
glenn-jocher

댓글