REST API Reference
API 인증에 필요한 API KEY는 플레어레인 콘솔 내 '프로젝트' 페이지에서 확인할 수 있습니다.
클라이언트에서 API를 직접 실행하지 마세요. API KEY 노출 위험이 있습니다.
POST
Request Params
Path Params
PROJECT_ID
required
String
프로젝트 ID
Header Parameters
Authorization
required
String
발급된 API KEY
ex) Bearer API_KEY
Body Parameters
targetType
required
String
발송 대상 유형 (segment, userId, device)
targetIds
required
Array
발송 대상의 id 배열
* targetType별 최대 개수
- segment: 5개
- userId,device: 100개
templateId
optional
String
템플릿 id. 템플릿 사용시 다른 파라미터가 함께 있어도 템플릿의 내용으로 대체됩니다.
title
optional
String
메시지 제목
body
optional
String
메시지 내용. templateId 와 body 중 하나는 반드시 존재해야 합니다.
url
optional
String
메시지 URL
imageUrl
optional
String
첨부할 이미지 URL
data
optional
Object
{key:value} 형태의 추가 변수 제공
ignoreFrequencyCapping
optional
Boolean
true 입력 시 현재 설정된 발송 빈도 제한을 무시하고 무조건 발송
ttl
optional
Number
알림 유효 기간(TTL) 설정. 초 단위 입력 (ex. 1일 = 86400)
flarelane_save_sent_history
optional
String
"false" 입력 시 알림함 적재되지 않음
POST
Request Params
Path Params
PROJECT_ID
required
String
프로젝트 ID
Header Parameters
Authorization
required
String
발급된 API KEY
ex) Bearer API_KEY
Body Parameters
events
required
Array
Event 객체 배열
events[]
required
Object
Event 객체 타입 정의
태그 값은 문자열(string) 혹은 숫자(number) 타입만 입력 가능합니다.
시간 표현은 second 가 아닌 millisecond 단위의 Unix Timestamp 값을 입력합니다. (ex. 1681721331085)
해당 유저 ID와 일치하는 기기들을 모두 찾아 태그 변경
PATCH
Request Params
Path Params
PROJECT_ID
required
String
프로젝트 ID
Header Parameters
Authorization
required
String
발급된 API KEY
ex) Bearer API_KEY
Body Parameters
userId
required
String
기기를 검색할 기준 User ID
tags
required
Object
{key:value} 형태의 태그 (null value 시 태그 삭제)
알림 내역 저장은 기본 비활성화되어 있습니다. 알림함 사용을 원하시면 문의 부탁드립니다.
기기로 발송된 최근 30일 동안의 알림 내역을 확인할 수 있습니다. 해당 데이터로 서비스 내 알림함을 구축할 수 있습니다.
GET
Request Params
Path Params
PROJECT_ID
required
String
프로젝트 ID
DEVICE_ID
required
String
기기 ID
Header Parameters
Authorization
required
String
발급된 API KEY
ex) Bearer API_KEY