API 키를 사용하면 애플리케이션이 BitcoinVN 계정의 일부에 접근할 수 있습니다. 모든 키를 비밀번호처럼 취급하세요. 키를 확보한 사람은 계정 정보를 보거나 키의 권한으로 허용된 작업을 수행할 수 있습니다.
키 생성 및 라벨 지정
키를 생성하기 전에 대상 기본 계정 또는 VIP 하위 계정이 활성 상태인지 확인하세요.
그다음:
- API 키 관리를 여세요.
- 새 키 생성을 선택하세요.
- 키를 사용할 애플리케이션에 복사하세요.
- 편집을 선택하세요.
- 애플리케이션이나 용도를 식별할 수 있는 라벨을 추가하세요.
- 권한과 선택적 IP 제한을 선택한 후 저장하세요.
애플리케이션마다 별도의 키를 사용하면 다른 연동에 영향을 주지 않고 하나의 연동을 제한하거나 해지할 수 있습니다. 라벨에 비밀 정보나 개인정보를 포함하지 마세요.
필요한 최소 권한 선택
BitcoinVN은 두 가지 권한 수준을 제공합니다.
- 읽기 전용: 계정 데이터를 볼 수 있지만 주문을 생성할 수 없습니다.
- 읽기 및 쓰기: 계정 데이터를 보고 주문을 생성할 수 있습니다.
읽기 및 쓰기 키는 계정 잔액을 사용하여 주문을 생성하고 결과 자금을 결제 목적지로 보낼 수 있습니다. 이러한 키를 확보한 사람은 자금을 출금할 수 있습니다.
애플리케이션이 실제로 주문을 생성해야 하는 경우가 아니면 읽기 전용 접근을 사용하세요.
IP 주소로 접근 제한
편집 페이지에서 키를 특정 IP 주소로 제한할 수 있습니다.
- 한 줄에 하나의 IP 주소를 입력하세요.
- 대상 애플리케이션이 사용하는 주소만 추가하세요.
- 애플리케이션이 고정 IP 주소를 사용할 수 없는 경우에만 필드를 비워 두세요.
IP 제한이 설정된 동안에는 다른 주소의 요청이 허용되지 않습니다. 애플리케이션의 주소가 변경되면 목록을 업데이트하세요.
API에서 키 사용
X-API-KEY 요청 헤더에 키를 보내세요.
X-API-KEY: <your-api-key>위 자리표시자는 예시일 뿐입니다. 실제 키를 공개 코드, 스크린샷, 지원 메시지, 브라우저 측 애플리케이션, URL 또는 로그에 넣지 마세요.
대화형 API 문서는 bitcoinvn.io/api/doc에서 확인할 수 있습니다.
하위 계정 컨텍스트 이해
API 키는 키를 생성할 때 활성 상태였던 계정에 계속 연결됩니다.
- 기본 계정에서 생성한 키는 기본 계정을 사용합니다.
- 하위 계정이 활성 상태일 때 생성한 키는 해당 하위 계정을 사용합니다.
웹사이트에서 계정을 전환해도 기존 키는 변경되지 않습니다. 키를 생성하기 전에 활성 계정을 확인하세요.
키 해지 또는 교체
API 키 관리를 열고 더 이상 필요하지 않은 키 옆의 해지를 선택하세요. 해지는 취소할 수 없습니다.
키가 노출되었을 가능성이 있는 경우:
- 키를 해지하세요.
- 대체 키를 생성하세요.
- 필요한 권한과 IP 제한을 적용하세요.
- 대상 애플리케이션을 업데이트하세요.
API 키를 BitcoinVN 지원팀이나 BitcoinVN을 대표한다고 주장하는 사람에게 보내지 마세요.