앱 ID
앱 ID는 UUID v4로 형식화된 OneSignal 프로젝트의 고유한 공개 식별자입니다. 비공개 API 키와 구별되며 다음에 필요합니다:- SDK 초기화 – 모바일 SDK 설정, 웹 SDK 설정
- API 호출 – 메시지 생성, 사용자 생성 등.
앱 ID 및 앱 API 키를 찾을 수 있는 키 및 ID 페이지.
앱 ID를 찾을 수 있는 위치 예시.
조직 ID
조직 ID(Org ID)는 청구 플랜에 따라 모든 앱을 그룹화하는 UUID v4 형식의 고유 식별자입니다. 다음과 관련된 API에 필요합니다: 대시보드의 조직 > 귀하의 조직 또는 앱 보기 API를 통해organization_id를 찾을 수 있습니다.
OneSignal 대시보드에서 조직 ID를 찾는 방법을 보여주는 예시.
API 키
API 키에는 두 가지 유형이 있습니다:- 앱 API 키
- 조직 API 키 – 조직 내에서 앱 및 API 키를 구성하는 데 사용되는 비공개 키.
앱 API 키
앱 API 키는 특정 앱과 관련된 대부분의 REST API 요청에 사용되는 비공개 키입니다.- 앱 API 키는 설정 > 키 및 ID 또는 API 키 생성에서 생성할 수 있습니다.
- 생성된 후에만 볼 수 있습니다.
-
key인증 체계를 사용하여Authorization헤더에 이 키를 포함합니다:
앱 API 키를 비밀번호처럼 취급하세요. 앱 코드에서 공유하거나 노출하거나 GitHub와 같은 공개 저장소에 저장하지 마세요.
조직 API 키
조직 API 키는 조직 내에서 앱 및 앱 API 키를 관리하는 데 사용되는 비공개 키입니다. 다음과 같은 API 요청에 필요합니다:- 앱 구성 – 앱 생성, 앱 보기
- API 키 관리 – API 키 생성, API 키 삭제, API 키 업데이트
조직 API 키는 레거시 사용자 인증 키를 대체합니다.
API 키 생성
- 앱 API 키 – 앱의 설정 > 키 및 ID로 이동하거나 API 키 생성 API를 사용합니다.
- 조직 API 키 – 조직의 키 및 ID 섹션으로 이동합니다.
API 키는 한 번만 표시됩니다. 키 추가를 사용하여 생성합니다.
IP 허용 목록
선택적으로 IP 허용 목록을 활성화하여 API 키 사용을 특정 IP 주소로 제한합니다. 공백으로 구분된 CIDR 블록을 입력합니다(예:192.0.2.0/24 192.0.2.123/32).
허용되지 않은 IP의 요청은 거부됩니다.
선택적 IP 허용 목록으로 API 키 생성.
API 키 보기
생성을 클릭하면 API 키가 한 번 표시됩니다. 안전하게 저장하세요.
생성된 API 키(한 번만 표시됨).
키 관리
키를 생성한 후 키 목록 인터페이스를 통해 관리할 수 있습니다:
키 ID는 참조용 레이블일 뿐 실제 API 키가 아닙니다.
API 키 편집
대시보드 또는 API 키 업데이트 API를 통해:- 이름 또는 IP 허용 목록 업데이트
- 비밀을 변경하지 않음—앱 코드 변경 불필요
API 키 교체
대시보드 또는 API 키 교체 API를 통해:- 키의 비밀을 교체합니다
- 동일한 이름 및 IP 설정 유지
- 새 키로 앱 또는 통합을 업데이트해야 합니다
API 키 삭제
대시보드 또는 API 키 삭제 API를 통해:- 키를 영구적으로 삭제합니다
- 해당 키를 사용한 추가 API 액세스를 차단합니다
레거시 API 키에서 마이그레이션
2024년 11월 14일에 풍부한 API 키 관리를 도입했습니다. 마이그레이션 단계- 새로운 풍부한 API 키를 생성합니다(위 참조).
- 코드베이스에서 레거시 키를 교체합니다.
- API 호출을 업데이트하여 이전
https://onesignal.com/api/v1/URL 대신https://api.onesignal.com을 사용합니다. - 키 및 ID 페이지에서 레거시 키를 삭제하거나 “레거시 키 비활성화”를 클릭합니다.
앱 비활성화
앱을 비활성화하면 다음이 차단됩니다:- 새 알림
- 전송 대기 중인 예약된 알림