Skip to Content
개발 문서인증 가이드

인증 가이드

모든 API 요청은 API Key를 통한 인증이 필요합니다. OfoxAI는 통합 API Key를 사용하며, 3대 프로토콜의 인증 방식을 지원합니다.

API Key 발급

  1. OfoxAI 콘솔 에 회원가입 및 로그인
  2. 설정API Keys로 이동
  3. 새 키 생성 클릭
  4. API Key를 복사하여 안전하게 보관

API Key는 생성 시 한 번만 표시됩니다. 반드시 안전하게 보관하세요. 분실 시 새로 생성해야 합니다.

인증 방식

사용하는 프로토콜에 따라 인증 방식이 약간 다릅니다:

OpenAI 호환 프로토콜Authorization Header를 사용합니다:

Authorization: Bearer <OFOXAI_API_KEY>
from openai import OpenAI client = OpenAI( base_url="https://api.ofox.ai/v1", api_key="<OFOXAI_API_KEY>" )

환경 변수 설정

API Key를 하드코딩하지 않도록 환경 변수로 관리하는 것을 권장합니다:

.env
OFOX_API_KEY=<OFOXAI_API_KEY> # 프로토콜 전용 환경 변수도 설정 가능 OPENAI_API_KEY=<OFOXAI_API_KEY> OPENAI_BASE_URL=https://api.ofox.ai/v1 ANTHROPIC_API_KEY=<OFOXAI_API_KEY> ANTHROPIC_BASE_URL=https://api.ofox.ai/anthropic GEMINI_API_KEY=<OFOXAI_API_KEY> GEMINI_BASE_URL=https://api.ofox.ai/gemini

보안 모범 사례

  1. 환경 변수 사용 — 절대로 코드에 API Key를 하드코딩하지 마세요
  2. 정기적인 키 순환 — 90일마다 교체하는 것을 권장합니다
  3. 환경 구분 — 개발 환경과 프로덕션 환경에 서로 다른 API Key 사용
  4. 사용량 모니터링 — 콘솔에서 API 사용량과 비정상 호출을 정기적으로 확인
  5. 권한 제한 — 다른 프로젝트에 대해 별도의 API Key를 생성하여 추적 및 관리를 용이하게

API Key를 Git 리포지토리에 커밋하거나 클라이언트 코드에 노출하지 마세요. .gitignore를 사용하여 .env 파일을 제외하세요.

Last updated on