API 키

API 키 이해하기

API 키는 테스트 키와 라이브 키로 나뉘어져 있어요. 키는 API 연동 계약 시 안내해드려요. 테스트 키는 test로 시작하고, 테스트 키를 이용한 모든 발행 요청은 가상으로 이루어져요.

인증 헤더 설정

볼타 API는 Basic 인증에 API 키를 사용합니다.

API 키로 인증하기

1. 볼타 워크스페이스에서 API 키를 생성해주세요.

관련 가이드: https://docs.bolta.io/docs/api-%ED%82%A4

2. API 키 뒤에 `:`을 추가하고 Base64로 인코딩하세요. 콜론을 빠트리지 않도록 주의하세요.

Base64('test_fkdk3o9d9s9a0239ssdfasd23asdasd:')
        ─────────────────┬───────────────── ┬
                     apiKey                 :
                   발급받은 API 키            콜론

아래 명령어를 터미널에서 실행하면 인코딩된 값을 얻을 수 있습니다.

3. 인코딩된 값을 API의 Basic 인증헤더에 사용하세요.

Authorization: Basic {ENCODED_SECRET_KEY}

Basic 인증 방식이란

Authorization: Basic base64({USERNAME}:{PASSWORD})

HTTP Basic 인증 방식은 클라이언트에서 Base64로 인코딩된 사용자 ID, 비밀번호 쌍을 인증 정보(credentials) 값으로 사용합니다. 사용자 ID와 비밀번호는 위와 같이 콜론으로 구분합니다. Base64로 인코딩한 정보는 쉽게 디코딩이 가능해서 Basic 인증은 반드시 HTTPS 및 TLS와 함께 사용해야 합니다.

볼타 API는 API 키를 사용자 ID로 사용하고, 비밀번호는 사용하지 않습니다. 비밀번호가 없다는 것을 알리기 위해 API 키 뒤에 콜론을 추가합니다.

API 키 이해하기#

인증 헤더 설정#

API 키로 인증하기#

1. 볼타 워크스페이스에서 API 키를 생성해주세요.#

2. API 키 뒤에 :을 추가하고 Base64로 인코딩하세요. 콜론을 빠트리지 않도록 주의하세요.#

3. 인코딩된 값을 API의 Basic 인증헤더에 사용하세요.#