These docs are for v1.0. Click to read the latest docs for v2.0.

Generate API key

API Key를 생성하기 위해서는 먼저 에이슬립 대시보드에 회원가입을 하셔야 합니다.

📘

Dashboard URL

https://dashboard.asleep.ai/

🚧

API Key 노출 주의

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

1. API Key 생성하기

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

로그인 화면

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

프로필 아이콘 - Settings

  1. API Key 블럭에서 Generate API Key 버튼을 클릭하세요.
API Key 생성 전

API Key 생성 전

  1. API Key가 생성 되었습니다.
Test API Key, Live API Key 각각 하나씩 생성됨

Test API Key, Live API Key 각각 하나씩 생성됨

2. Test API Key와 Live API Key의 구분

2.1 구분

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

2.2 특징

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