website logo
⌘K
🚀시작하기
📈마케터용 가이드
🛠️개발자용 가이드
플레어레인 홈페이지
플레어레인 콘솔
Docs in English
Docs powered by archbee 

REST API Reference

API 인증에 필요한 API KEY는 플레어레인 콘솔 내 '프로젝트' 페이지에서 확인할 수 있습니다.

클라이언트에서 API를 직접 실행하지 마세요. API KEY 노출 위험이 있습니다.

무료 플랜(스타터)의 경우 분당 100회까지의 API 요청 제한이 있습니다. 유료 플랜 전환 시 무제한 사용이 가능합니다.

POST
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: 1개(팀 플랜 이상 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} 형태의 추가 변수 제공
Curl
|
curl --request POST 'https://api.flarelane.com/v1/projects/PROJECT_ID/notifications' \
  --header 'Authorization: Bearer API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "targetType": "device",
      "targetIds": ["<device-id>"],
      "title": "안녕하세요",
      "body": "반갑습니다"
  }'
RESPONSES
200
|
{
    "data": {
        "id": "<notification-id>"
    }
}

해당 유저 ID와 일치하는 기기들을 모두 찾아 태그 변경
PATCH
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 시 태그 삭제)
Curl
|
curl --request POST 'https://api.flarelane.com/v1/projects/PROJECT_ID/users/tags' \
  --header 'Authorization: Bearer API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "userId": "USER-ID",
      "tags": {
        "orderCount": 5,
        "nickName": "MYNAME"
      }
  }'
RESPONSES
200
|
{
    "data": {
        "devices": [
            {
                "id": "<device-id>",
                "userId": "USER-ID",
                "tags": {
                    "orderCount": 5,
                    "nickName": "MYNAME"
                }
            },
            ...
        ]
    }
}

기기로 발송된 최근 30일 동안의 알림 내역을 확인할 수 있습니다. 해당 데이터로 서비스 내 알림함을 구축할 수 있습니다.
GET
Params
Path Params
PROJECT_ID
required
String
프로젝트 ID
DEVICE_ID
required
String
기기 ID
Header Parameters
Authorization
required
String
발급된 API KEY ex) Bearer API_KEY
Curl
|
curl --location --request GET 'https://api.flarelane.com/v1/projects/PROJECT_ID/devices/DEVICE_ID/notification-history' \
  --header 'Authorization: Bearer API_KEY'
RESPONSES
200
|
{
    "data": [
        {
            "notification": {
                "id": "NOTIFICATION_ID",
                "createdAt": "2022-12-22T10:18:00.453Z",
                "title": "NOTIFICATION_TITLE",
                "body": "NOTIFICATION_BODY",
                "url": "NOTIFICATION_URL",
                "imageUrl": "NOTIFICATION_TITLE_IMAGE_URL"
            },
            "sentAt": "2022-12-22T10:18:29.847Z"
        },
        ...
    ],
}

POST
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 객체 타입 정의
Curl
|
curl --request POST 'https://api.flarelane.com/v1/projects/PROJECT_ID/events' \
  --header 'Authorization: Bearer API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "events": [{
        "type": "ViewProduct",
        "subjectType": "device",
        "subjectId": "00000000-49b6-4f9a-8891-c40e7ab1741f",
        "data": {
            "productId": "123"
        }
      }]
  }'
RESPONSES
200
|
{
    "data": {
        "success": 1,
        "error": []
    }
}




Did this page help you?
Yes
No
PREVIOUS
Wix 연동하기
NEXT
Web Push SDK Reference
Docs powered by archbee 
메시지 발송하기
TABLE OF CONTENTS
POST
메시지 발송하기
PATCH
User ID로 태그 변경
GET
기기별 알림 수신 내역
POST
이벤트 발생