📘

Dashboard URL

https://dashboard.asleep.ai/

🚧

API Key 노출 주의

API Key는 에이슬립 서비스 사용에 필요 라이센스 키입니다.
개발에 사용하는 API Key가 외부로 유출되지 않도록 주의해주세요.

API Key 생성하기

1. 회원가입을 완료한 계정으로 로그인 하세요.

2. 대시보드의 우측 상단에 [프로필 아이콘]을 클릭하고, [Settings]를 클릭하세요.

3. API Key 블럭에서 [Generate] 버튼을 클릭하세요.

4. 생성할 환경(Live 또는 Test)을 선택하고 [Generate Key] 버튼을 클릭하세요.

5. API Key가 생성되었습니다. [Copy] 버튼으로 키 값을 복사해 사용하세요.

📘

API Key 다시 보기

생성된 키 값은 목록의 [눈] 아이콘을 클릭하면 다시 확인하거나 복사할 수 있습니다.

Test API Key와 Live API Key의 구분

구분

• Test API Key: 개발 환경에서 사용하는 API Key입니다.
• Live API Key: 프로덕션 환경에서 사용하는 API Key입니다.

특징

• 실제 유저 데이터만 분리해서 확인하고 싶다면 Test API Key와 Live API Key를 용도에 맞게 분리 사용하는걸 권장합니다.
• 모든 데이터(유저, 세션)는 각 환경별로 구분되어 관리됩니다.
• 각 환경마다 최대 3개, 총 6개의 API Key를 생성할 수 있습니다.
• API Key별로 API 사용량, DAU 등을 구분해서 확인할 수 있습니다.
• Test, Live 각각의 환경 내에서는 API Key가 바뀌어도 유저 정보 및 세션 정보가 유지됩니다.
• [Trial Plan]에서는 Test API Key Key를 사용하셔야 합니다.
• [Enterprise Plan]의 Live API Key, Test API Key 모두에서 발생하는 유효 API call은 과금 대상입니다.

API Key 폐기하기 (Revoke)

더 이상 사용하지 않거나 외부에 유출된 것으로 의심되는 API Key는 안전을 위해 즉시 폐기(Revoke)해야 합니다.

🚧

폐기는 되돌릴 수 없습니다

• 폐기 즉시 해당 키를 사용한 모든 API 요청은 401 Unauthorized 에러와 함께 차단됩니다.
• 한 번 폐기된 키 값은 어떤 경우에도 다시 활성화하거나 복구할 수 없습니다.

Tip: 서비스 중단을 방지하려면? 운영 중인 서비스의 API Key를 교체해야 하는 경우 [Generate]를 통해 새 키를 먼저 발급받아 시스템에 반영한 후 기존 키를 폐기하시는 것을 권장합니다.

폐기 방법

1. Settings의 API Key 블록에서 [Current] 탭에 표시된 키 중 폐기할 키의 [Revoke] 버튼을 클릭하세요.

2. 확인 다이얼로그가 나타나면 주의사항을 확인하고 [Revoke] 버튼을 클릭하세요.

3. 폐기된 키는 즉시 사용 불가 상태로 바뀌며, [History] 탭에서 생성 일자와 폐기 일자를 확인할 수 있습니다.

📘

새 키 생성 한도 안내

폐기 완료된 키는 환경별 보유 한도(최대 3개)에서 즉시 제외되므로, 필요한 경우 같은 환경에 새 키를 바로 생성할 수 있습니다.