메인 콘텐츠로 건너뛰기

API 키

모든 v1 엔드포인트는 x-api-key 헤더에 API 키가 필요합니다.

API 키 생성

  1. AFKCrypto 대시보드에 로그인
  2. API Keys 섹션으로 이동
  3. “Generate API Key” 클릭
  4. 키에 설명적인 이름 지정
  5. 선택: 만료 기간 설정(7일, 30일, 90일, 180일, 1년)
  6. 즉시 키를 복사(다시 표시되지 않음)

키 형식

afk_<prefix>_<random>

예: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56
  • Prefix: 빠른 식별을 위한 4자 식별자
  • Random: 암호학적으로 안전한 32자 랜덤 문자열

API 키 사용

모든 요청에 x-api-key 헤더로 키를 포함합니다.
curl -X GET https://api.afkcrypto.com/api/v1/wallets \
  -H "x-api-key: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56"

보안 모범 사례

  • API 키를 버전 관리에 커밋하지 않기: 환경 변수 사용
  • 정기적으로 키 로테이션: 임시 액세스에는 만료 설정
  • 환경별로 키 분리: dev, staging, production
  • 미사용 키 즉시 취소: 공격 면적 축소
  • 안전한 보관: 시크릿 매니저 사용(예: AWS Secrets Manager, HashiCorp Vault)

키 만료

API 키는 지정된 기간 후 만료되도록 설정할 수 있습니다.
  • 만료 없음(기본): 취소 전까지 유효
  • 7일: 단기 테스트/데모
  • 30일: 계약자 액세스/평가판
  • 90일: 분기별 로테이션 권장
  • 180일: 반기 로테이션
  • 1년: 안정적 통합을 위한 연간 로테이션
만료 시 동작
  • 해당 키로의 요청은 HTTP 401 UNAUTHORIZED 반환
  • 키는 대시보드에 감사 용도로 표시 유지
  • 대체할 새 키를 생성
만료 모니터링
  • 대시보드에 “Expired” 또는 “Expiring soon”(≤ 7일) 라벨 표시
  • 중단 방지를 위한 알림 구성

키 한도

  • 활성 키 최대 수: 사용자당 10개
  • 요청 제한이 적용됨: Rate limiting 참조
  • 한도 유지를 위해 미사용 키를 취소

API 키 취소

대시보드에서 즉시 취소할 수 있습니다.
  1. API Keys 열기
  2. 취소할 키 찾기
  3. “Revoke Key” 클릭
  4. 작업 확인
참고: 취소는 영구적이며 즉시 적용됩니다.

관련