Only this pageAll pages
Powered by GitBook
1 of 22

ํ•œ๊ตญ์–ด

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Identity

Event

Import API

Profile

Export API

Export

API

์‹œ์ž‘ํ•˜๊ธฐ

DFINERY์˜ API๋ฅผ ํ†ตํ•ด ์˜จ/์˜คํ”„๋ผ์ธ ์œ ์ €์˜ ์ด๋ฒคํŠธ ๋ฐ ์†์„ฑ์„ ์ „์†กํ•˜๊ณ , ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”์ถœํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์‹œ์ž‘ํ•˜๊ธฐ ์ „์—

DFINERY์˜ API๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ ์ „์—, ์•„๋ž˜ ์‚ฌํ•ญ์ด ์‚ฌ์ „์— ์ค€๋น„๋˜์–ด ์žˆ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

  1. ํšŒ์›๊ฐ€์ž… ๋ฐ ์กฐ์ง, ์„œ๋น„์Šค ์ƒ์„ฑ : API๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด์„œ๋Š” ํšŒ์›๊ฐ€์ž… ํ›„, ์กฐ์ง๊ณผ ์„œ๋น„์Šค๊ฐ€ ์ƒ์„ฑ๋˜์–ด ์žˆ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์ด์šฉ์ž ๊ฐ€์ด๋“œ์˜ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ ์‹œ์ž‘ํ•˜๊ธฐ๋ฅผ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

  2. ์ด๋ฒคํŠธ ๋ฐ ์œ ์ € ์†์„ฑ ๋“ฑ๋ก : DFINERY๋Š” ์‚ฌ์ „ ๋“ฑ๋ก๋œ ์ด๋ฒคํŠธ์™€ ์œ ์ € ์†์„ฑ ๋ฐ์ดํ„ฐ๋งŒ์„ ์ ์žฌํ•ฉ๋‹ˆ๋‹ค. ์ ์žฌํ•˜๊ณ ์ž ํ•˜๋Š” ์ด๋ฒคํŠธ์™€ ์œ ์ € ์†์„ฑ ๋ฐ์ดํ„ฐ๊ฐ€ ์žˆ๋‹ค๋ฉด ๋ฏธ๋ฆฌ ์ฝ˜์†”์—์„œ ๋“ฑ๋กํ•˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์ด์šฉ์ž ๊ฐ€์ด๋“œ์˜ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ ์‹œ์ž‘ํ•˜๊ธฐ๋ฅผ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

  3. API ํ† ํฐ ๋ฐœ๊ธ‰ : DFINERY๋Š” API ํ† ํฐ์„ ํ†ตํ•ด ์‚ฌ์šฉ์ž๊ฐ€ ๋ณด๋‚ธ ์š”์ฒญ์ด ์ธ์ฆ๋œ ์š”์ฒญ์ธ์ง€ ํŒ๋‹จํ•ฉ๋‹ˆ๋‹ค. API ํ† ํฐ์€ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ ์ฝ˜์†”์„ ํ†ตํ•ด ๋ฐœ๊ธ‰ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์„ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

  4. API ์š”์ฒญ ์ œํ•œ ๊ณ ๋ ค : DFINERY๋Š” ์„œ๋น„์Šค๋ณ„๋กœ ์‹œ๊ฐ„๋‹น API ํ˜ธ์ถœ ํšŸ์ˆ˜๋ฅผ ์ œํ•œํ•ฉ๋‹ˆ๋‹ค. API ์š”์ฒญ ์‹œ์—๋Š” API ์š”์ฒญ ์ œํ•œ์„ ๊ณ ๋ คํ•˜์—ฌ ์š”์ฒญํ•˜๋„๋ก ์„ค๊ณ„ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์„ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

DFINERY API๋Š” ์•„๋ž˜ ํ•œ๊ฐœ์˜ ๋„๋ฉ”์ธ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

URL
์„ค๋ช…

DFINERY๋Š” ์•„๋ž˜์™€ ๊ฐ™์€ ์ข…๋ฅ˜์˜ API๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

๋ถ„๋ฅ˜
์„ค๋ช…

DFINERY API์—์„œ๋Š” ์ผ๊ด€๋œ ๋ฐ์ดํ„ฐ ํƒ€์ž…๊ณผ ํฌ๋งท์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๊ฐ€ API๋ฅผ ์—ฐ๋™ํ•  ๋•Œ์—๋Š” API์—์„œ ์š”๊ตฌํ•˜๋Š” ๋ฐ์ดํ„ฐ ํƒ€์ž…์— ๋งž์ถฐ ์š”์ฒญํ•˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์„ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

DFINERY๋Š” API ํ† ํฐ์„ ํ†ตํ•ด ์‚ฌ์šฉ์ž๊ฐ€ ๋ณด๋‚ธ ์š”์ฒญ์ด ์ธ์ฆ๋œ ์š”์ฒญ์ธ์ง€ ํŒ๋‹จํ•ฉ๋‹ˆ๋‹ค. ๋ชจ๋“  API ์š”์ฒญ์˜ ํ—ค๋”์—๋Š” API ํ† ํฐ์ด ํ•„์ˆ˜๋กœ ํฌํ•จ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. API ํ† ํฐ์€ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ ์ฝ˜์†”์„ ํ†ตํ•ด ๋ฐœ๊ธ‰ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

DFINERY์˜ API ํ† ํฐ์€ Import API, Export API ํ† ํฐ์œผ๋กœ ๋‚˜๋‰˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. Import API ํ† ํฐ์€ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ์— ๊ณ ๊ฐ์‚ฌ์˜ ๋ฐ์ดํ„ฐ๋ฅผ ์ „์†กํ•  ๋•Œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค (Event, Identity, Profile API). Export API ํ† ํฐ์€ ๊ณ ๊ฐ์‚ฌ๊ฐ€ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ์— ์ ์žฌ๋˜์–ด ์žˆ๋Š” ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”์ถœํ•  ๋•Œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค (Export API).

์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์„ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

DFINERY๋Š” ์•ˆ์ •์ ์ธ ์„œ๋น„์Šค ์šด์˜์„ ์œ„ํ•ด ์„œ๋น„์Šค๋ณ„๋กœ ์‹œ๊ฐ„๋‹น API ์š”์ฒญ ํšŸ์ˆ˜๋ฅผ ์ œํ•œํ•ฉ๋‹ˆ๋‹ค. API ์š”์ฒญ ์ œํ•œ์„ ์ดˆ๊ณผํ•˜๋ฉด ์ดํ›„์˜ ๋ชจ๋“  ์š”์ฒญ์€ ์‹คํŒจํ•˜๊ณ , ์ œํ•œ ์‹œ๊ฐ„์ด ์ง€๋‚˜ ์š”์ฒญ ์ œํ•œ์ด ์ดˆ๊ธฐํ™”๋œ ํ›„ ์š”์ฒญ์ด ์„ฑ๊ณตํ•ฉ๋‹ˆ๋‹ค. API ์š”์ฒญ ์ œํ•œ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ์„ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

๋ฐ์ดํ„ฐ ํƒ€์ž…

DFINERY์˜ API๋Š” ์•„๋ž˜์˜ ๋ฐ์ดํ„ฐ ํƒ€์ž…์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์‚ฌ์šฉ์ž๊ฐ€ API๋ฅผ ์—ฐ๋™ํ•  ๋•Œ์—๋Š” API์—์„œ ์š”๊ตฌํ•˜๋Š” ๋ฐ์ดํ„ฐ ํƒ€์ž…์— ๋งž์ถฐ ์š”์ฒญํ•˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํƒ€์ž…
ํฌ๋งท
์˜ˆ์‹œ

String

-

"foo"

์ธ์ฆ

DFINERY๋Š” API ํ† ํฐ์„ ํ†ตํ•ด ์‚ฌ์šฉ์ž๊ฐ€ ๋ณด๋‚ธ ์š”์ฒญ์ด ์ธ์ฆ๋œ ์š”์ฒญ์ธ์ง€ ํŒ๋‹จํ•ฉ๋‹ˆ๋‹ค. ๋ชจ๋“  API ์š”์ฒญ์˜ ํ—ค๋”์—๋Š” API ํ† ํฐ์ด ํ•„์ˆ˜๋กœ ํฌํ•จ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. API ํ† ํฐ์€ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ ์ฝ˜์†”์„ ํ†ตํ•ด ๋ฐœ๊ธ‰ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

DFINERY์˜ API ํ† ํฐ์€ Import API, Export API ํ† ํฐ์œผ๋กœ ๋‚˜๋‰˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. Import API ํ† ํฐ์€ ์ฃผ๋กœ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ์— ๊ณ ๊ฐ์‚ฌ์˜ ๋ฐ์ดํ„ฐ๋ฅผ ์ „์†กํ•  ๋•Œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค (Event, Identity, Profile API). Export API ํ† ํฐ์€ ์ฃผ๋กœ ๊ณ ๊ฐ์‚ฌ๊ฐ€ ๋””ํŒŒ์ด๋„ˆ๋ฆฌ์— ์ ์žฌ๋˜์–ด ์žˆ๋Š” ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”์ถœํ•  ๋•Œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค (Export API).

API ํ† ํฐ ๋ฐœ๊ธ‰

๋””ํŒŒ์ด๋„ˆ๋ฆฌ ์ฝ˜์†”์— ๋กœ๊ทธ์ธ ํ›„ ์ขŒ์ธก ๋ฉ”๋‰ด์˜ ์„œ๋น„์Šค ๊ด€๋ฆฌ์— ๋“ค์–ด๊ฐ€์‹œ๋ฉด Key ์ •๋ณด์—์„œ API ํ† ํฐ์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค (์„œ๋น„์Šค ๊ด€๋ฆฌ > Key ์ •๋ณด > API ํ† ํฐ).

  • ํ† ํฐ ๋ฐœ๊ธ‰ / ์žฌ๋ฐœ๊ธ‰ / ์‚ญ์ œ๋Š” ์„œ๋น„์Šค ๊ด€๋ฆฌ์ž๋งŒ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

  • API ํ† ํฐ์€ ์„œ๋น„์Šค ์ƒ์„ฑ ์‹œ ์ž๋™ ๋ฐœ๊ธ‰๋˜๋ฉฐ ์žฌ๋ฐœ๊ธ‰๋งŒ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

Import API ํ† ํฐ์€ ์š”์ฒญ ํ—ค๋”์— access_token ๊ฐ’์„ ์ถ”๊ฐ€ํ•˜์—ฌ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Emport API ํ† ํฐ์€ ์š”์ฒญ ํ—ค๋”์— Authorization ๊ฐ’์„ ์ถ”๊ฐ€ํ•˜์—ฌ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

DFINERY์—์„œ๋Š” ์„œ๋น„์Šค ๋ณ„ 1๊ฐœ์˜ API ํ† ํฐ๋งŒ ๋ฐœ๊ธ‰์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ๋งŒ์•ฝ ํ† ํฐ์„ ๋ณ€๊ฒฝํ•˜๊ณ  ์‹ถ์„ ๋•Œ๋Š” ์žฌ๋ฐœ๊ธ‰ ๋ฒ„ํŠผ์„ ํ†ตํ•ด ๋ณ€๊ฒฝ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค (์„œ๋น„์Šค ๊ด€๋ฆฌ > Key ์ •๋ณด > API ํ† ํฐ > ์žฌ๋ฐœ๊ธ‰).

ํ† ํฐ ๊ด€๋ จ ์‘๋‹ต ์ฝ”๋“œ ๋ฐ ๊ณตํ†ต ์—๋Ÿฌ ๋ฐ ์ฝ”๋“œ๋Š” ํƒญ์„ ์ฐธ๊ณ ํ•ด ์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

POST: ํ†ตํ•ฉ ํ”„๋กœํ•„ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ

POST /api/v1/identities

๊ณ ๊ฐ์˜ ํ†ตํ•ฉ ํ”„๋กœํ•„์„ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ ํ•  ์ˆ˜ ์žˆ๋Š” API ์ž…๋‹ˆ๋‹ค.

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์‹œ์ž‘ํ•˜๊ธฐ

Profile API๋ฅผ ํ†ตํ•ด ์œ ์ €์˜ ์†์„ฑ์„ ์ƒ์„ฑํ•˜๊ฑฐ๋‚˜ ์—…๋ฐ์ดํŠธ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. API ์—ฐ๋™์„ ์œ„ํ•ด์„œ๋Š” ๋จผ์ € ๊ธฐ๋ณธ ์„ธํŒ…์„ ์™„๋ฃŒํ•˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค. API ์—ฐ๋™์„ ์œ„ํ•œ ๊ธฐ๋ณธ ์„ธํŒ…์„ ์•„์ง ํ•˜์ง€ ๋ชปํ–ˆ๋‹ค๋ฉด, ๋ฅผ ์ฐธ๊ณ ํ•ด ์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์œ ์ € ์†์„ฑ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ API๋ฅผ ํ†ตํ•ด ์˜จ/์˜คํ”„๋ผ์ธ ์ฑ„๋„์— ๋Œ€ํ•œ ์œ ์ €์˜ ์ˆ˜์‹  ๋™์˜ ์ •๋ณด ๊ฐ’์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์•Œ๋ฆผ ์ˆ˜์‹  ๋™์˜ ์ •๋ณด์— ๋Œ€ํ•œ ์œ ์ € ํ”„๋กœํ•„์€ ์˜ˆ์™ธ์ ์œผ๋กœ DFINERY์—์„œ ์„œ๋น„์Šค ์ƒ์„ฑ ์‹œ ์ด๋ฏธ ์ž๋™์œผ๋กœ ๋“ฑ๋ก๋˜์–ด ์žˆ์–ด DFINERY ์ฝ˜์†”์—์„œ ์„ค์ •ํ•˜์ง€ ์•Š์•„๋„ ์„ค์ •์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

์ˆ˜์‹  ๋™์˜ ์ •๋ณด๋Š” ๊ธฐ๋ณธ๊ฐ’์„ ํ†ตํ•ด ๋”ฐ๋กœ ์„ค์ •ํ•˜์ง€ ์•Š์•„๋„ ๋ฐœ์†ก๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์‚ฌํ•ญ์€ ์ด์šฉ์ž ๊ฐ€์ด๋“œ์˜ ๋ฅผ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

Long

-

1

Double

-

1.0

Boolean

-

true

Array of String

-

["foo", "bar"]

Array of Long

-

[0, 1]

Array of Double

-

[0.0, 1.0]

Datetime

yyyy-MM-dd'T'HH:mm:ss(.SSS)Z

2023-08-15T12:30:00.000Z, 2023-08-15T12:30:00Z,

Date

yyyy-MM-dd

2023-08-15

์‚ฌ์šฉ ์‚ฌ๋ก€

์•Œ๋ฆผ ์ˆ˜์‹  ๋™์˜ ์ •๋ณด ์„ค์ •ํ•˜๊ธฐ

์‹œ์ž‘ํ•˜๊ธฐ ์ „์—
์˜คํ›„ 9์‹œ ๋ถ€ํ„ฐ ์˜ค์ „ 8์‹œ ์‚ฌ์ด์—๋Š” ๋ณ„๋„์˜ ์ˆ˜์‹  ๋™์˜๋ฅผ ๋ฐ›์•„์•ผ ๊ด‘๊ณ ์„ฑ ์•Œ๋ฆผ์„ ์ „์†กํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
์ˆ˜์‹  ๋™์˜ ์ƒํƒœ ๋ณ„ ํ‘œ๊ธฐ

API ํ† ํฐ์„ ํ†ตํ•œ ์š”์ฒญ

Import API

Export API

API ํ† ํฐ ์žฌ๋ฐœ๊ธ‰

์žฌ๋ฐœ๊ธ‰ ์‹œ ๊ธฐ์กด ํ† ํฐ์€ 2์ฃผ ๋™์•ˆ๋งŒ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. 2์ฃผ ๋‚ด์— ์žฌ๋ฐœ๊ธ‰ํ•œ ํ† ํฐ์œผ๋กœ ๋ณ€๊ฒฝํ•ด ์ฃผ์„ธ์š”.

API ํ† ํฐ ๊ด€๋ จ ์‘๋‹ต ์ฝ”๋“œ

Response
curl -X GET "https://openapi.dfinery.ai/api/v1/..." \
-H "access_token: ${your-import-api-token}"
curl -X GET "https://openapi.dfinery.ai/api/v1/..." \
-H "Authorization: Bearer ${your-export-api-token}"

DFINERY์— ์ ์žฌ๋˜์–ด ์žˆ๋Š” ์œ ์ €์˜ ์ด๋ฒคํŠธ ๋ฐ ํ–‰๋™ ๋ฐ์ดํ„ฐ๋ฅผ ์ถ”์ถœํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

https://openapi.dfinery.ai

DFINERY API ๋„๋ฉ”์ธ

Event

์œ ์ €์˜ ์ด๋ฒคํŠธ ๋ฐ์ดํ„ฐ๋ฅผ ์ ์žฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Identity

์œ ์ € ์‹๋ณ„์ •๋ณด๋ฅผ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค. ์ด๋ฅผ ํ†ตํ•ด ์œ ์ €๋ฅผ ์‹๋ณ„ํ•˜๊ณ , ํ†ตํ•ฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Profile

์œ ์ €์˜ ์†์„ฑ์„ ์—…๋ฐ์ดํŠธ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

access_token: ${your-import-api-token}
Authorization: Bearer ${your-export-api-token}

API

๋„๋ฉ”์ธ

API ์ปฌ๋ ‰์…˜

๋ฐ์ดํ„ฐ ํƒ€์ž…

์ธ์ฆ

Import API ํ† ํฐ

Export API ํ† ํฐ

์š”์ฒญ ์ œํ•œ

์ธ์ฆ
์š”์ฒญ ์ œํ•œ
๋ฐ์ดํ„ฐ ํƒ€์ž…
์ธ์ฆ
์š”์ฒญ ์ œํ•œ

service_id

ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…

Content-Type

ํ•„์ˆ˜

String

application/json

-

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

identity

ํ•„์ˆ˜

Object

์ด๋ฒคํŠธ ์ ์žฌ๋ฅผ ์œ„ํ•œ ๊ณตํ†ต ์†์„ฑ

request_datetime

์œ ์ € ์‹๋ณ„ ์ •๋ณด์ž…๋‹ˆ๋‹ค. ์•„๋ž˜ ํ•„๋“œ ์ค‘ ์ ์–ด๋„ ํ•˜๋‚˜์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

external_id

์„ ํƒ

String

์™ธ๋ถ€ ID

phone_no

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ƒ์„ธ ์‘๋‹ต ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

curl -L \
  -X POST \
  -H 'access_token: ${your-import-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/identities?service_id=${your-service-id}' \
  -d '{
   "identity":{
      "external_id": "dfn-user-123",
      "email": "dfn@gmail.com",
      "phone_no": "821012345678"
   },
   "request_datetime":"2024-06-24T06:01:48.501Z"
  }
 '
Content-Type: application/json
access_token: text
{
  "status": true,
  "code": "20000",
  "message": "OK",
  "data": true
}

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

identity

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์ •์ƒ ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

POST: ํ†ตํ•ฉ ํ”„๋กœํ•„ ์‚ญ์ œ

POST /api/v1/identities/delete

๊ณ ๊ฐ์˜ ํ†ตํ•ฉ ํ”„๋กœํ•„์„ ์‚ญ์ œํ•  ์ˆ˜ ์žˆ๋Š” API ์ž…๋‹ˆ๋‹ค.

ํ†ตํ•ฉ ํ”„๋กœํ•„์„ ์‚ญ์ œํ•˜๋Š” ์š”์ฒญ์€ ๋˜๋Œ๋ฆด ์ˆ˜ ์—†์œผ๋‹ˆ ์‹ ์ค‘ํ•˜๊ฒŒ ํ˜ธ์ถœํ•˜์—ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์œ ์ € ์‹๋ณ„ ์ •๋ณด์ž…๋‹ˆ๋‹ค. ์•„๋ž˜ ํ•„๋“œ ์ค‘ ์ ์–ด๋„ ํ•˜๋‚˜์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

๋ชจ๋ฒ” ์‚ฌ๋ก€

์•„๋ž˜์˜ ๋ชจ๋ฒ” ์‚ฌ๋ก€๋Š” API ์—ฐ๋™์„ ์œ„ํ•œ ๊ธฐ๋ณธ ์„ธํŒ…์„ ์™„๋ฃŒํ•˜์˜€๋‹ค๊ณ  ๊ฐ€์ •ํ•ฉ๋‹ˆ๋‹ค. API ์—ฐ๋™์„ ์œ„ํ•œ ๊ธฐ๋ณธ ์„ธํŒ…์„ ์•„์ง ํ•˜์ง€ ๋ชปํ–ˆ๋‹ค๋ฉด, ์‹œ์ž‘ํ•˜๊ธฐ ์ „์— ๋ฅผ ์ฐธ๊ณ ํ•ด ์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์˜คํ”„๋ผ์ธ ๋ฐ์ดํ„ฐ๋ฅผ DFINERY ์„œ๋ฒ„๋กœ ์ „์†ก

DFINERY Import API๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๋‹ค์–‘ํ•œ ์˜คํ”„๋ผ์ธ ๋ฐ์ดํ„ฐ๋ฅผ DFINERY ์„œ๋ฒ„๋กœ ์ „์†กํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์‹ ๊ทœ ์œ ์ € ์œ ์ž… ํ›„ ์œ ์ € ์†์„ฑ ์—…๋ฐ์ดํŠธ, ์ด๋ฒคํŠธ ๋ฐœ์ƒ ์‹œ๋‚˜๋ฆฌ์˜ค

์œ ์ €๊ฐ€ ์˜คํ”„๋ผ์ธ ๋งค์žฅ์„ ํ†ตํ•ด ๊ฐ€์ž…ํ•œ ์ดํ›„ ๋งˆ์ผ€ํŒ… ์ˆ˜์‹ ๋™์˜๋ฅผ ํ•˜์˜€์Šต๋‹ˆ๋‹ค. ํ•ด๋‹น ์œ ์ €๋Š” ์ดํ›„ ์˜คํ”„๋ผ์ธ ๋งค์žฅ์—์„œ ๊ตฌ๋งค๋ฅผ ํ•˜์˜€์Šต๋‹ˆ๋‹ค.

  1. ์˜คํ”„๋ผ์ธ ๋งค์žฅ์„ ํ†ตํ•ด ๊ฐ€์ž… ์‹œ, ํ†ตํ•ฉ ํ”„๋กœํ•„ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ API ๋ฅผ ํ†ตํ•ด ์‹ ๊ทœ ์œ ์ €์˜ ํ”„๋กœํ•„์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.

  2. ๊ฐ€์ž… ์ดํ›„ ๋งˆ์ผ€ํŒ… ์ˆ˜์‹ ๋™์˜ ์‹œ, ์œ ์ € ์†์„ฑ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ API ๋ฅผ ํ†ตํ•ด ํ•ด๋‹น ์œ ์ €์˜ ๋งˆ์ผ€ํŒ… ์ˆ˜์‹ ๋™์˜ ์†์„ฑ์„ ์—…๋ฐ์ดํŠธํ•ฉ๋‹ˆ๋‹ค.

  3. ์ดํ›„ ์˜คํ”„๋ผ์ธ ๋งค์žฅ์—์„œ ๊ตฌ๋งค ์‹œ, ๋ฅผ ํ†ตํ•ด ํ•ด๋‹น ์œ ์ €์˜ ๊ตฌ๋งค ์ด๋ฒคํŠธ๋ฅผ ์ ์žฌํ•ฉ๋‹ˆ๋‹ค.

์š”์ฒญ ์ œํ•œ

์š”์ฒญ ์ œํ•œ์€ ์‹œ๊ฐ„ ๋‹จ์œ„๋‹น API ํ˜ธ์ถœ ํšŸ์ˆ˜ ์ œํ•œ์„ ์˜๋ฏธํ•ฉ๋‹ˆ๋‹ค. DFINERY๋Š” ์•ˆ์ •์ ์ธ ์„œ๋น„์Šค ์šด์˜์„ ์œ„ํ•ด ์ œ๊ณตํ•˜๋Š” ๋ชจ๋“  Open API์— ์š”์ฒญ ์ œํ•œ ์ •์ฑ…์„ ์ ์šฉํ•ฉ๋‹ˆ๋‹ค.

๋ถ„๋ฅ˜
Rate Limit (๊ธฐ๋ณธ)

access_token

ํ•„์ˆ˜

String

your-api-token-key

API ์ธ์ฆ ํ† ํฐ

ํ•„์ˆ˜

Datetime

์š”์ฒญ ์‹œ๊ฐ, ISODate 8601 Format, UTC ํƒ€์ž„์กด ๊ธฐ์ค€ 2024-06-24T06:42:25.394Z

์„ ํƒ

String

์ „ํ™” ๋ฒˆํ˜ธ

email

์„ ํƒ

String

์ด๋ฉ”์ผ

kakao_user_id

์„ ํƒ

String

์นด์นด์˜ค ID

line_user_id

์„ ํƒ

String

๋ผ์ธ ID

์ผ๋ฐ˜์ ์œผ๋กœ ํ†ตํ•ฉ ํ”„๋กœํ•„ ์ƒ์„ฑ > ์œ ์ € ํ”„๋กœํ•„ ์ƒ์„ฑ > ์ด๋ฒคํŠธ ์ ์žฌ API ์ˆœ์œผ๋กœ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ์ ์žฌ API
Export

access_token

ํ•„์ˆ˜

String

your-api-token-key

API ์ธ์ฆ ํ† ํฐ

Datetime

์š”์ฒญ ์‹œ๊ฐ, ISODate 8601 Format, UTC ํƒ€์ž„์กด ๊ธฐ์ค€ 2024-06-24T06:42:25.394Z

service_id

ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

Content-Type

ํ•„์ˆ˜

String

application/json

-

identity

ํ•„์ˆ˜

Object

์‹๋ณ„์ž ํ•„๋“œ

request_datetime

external_id

ํ•„์ˆ˜

String

์™ธ๋ถ€ ID

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

identity

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์ •์ƒ ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

์ƒ์„ธ ์‘๋‹ต
ํ•„์ˆ˜
curl -L \
  -X POST \
  -H 'access_token: ${your-import-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/identities/delete?service_id=${your-service-id}' \
  -d '{
   "identity":{
      "external_id": "dfn-user-123"
   },
   "request_datetime":"2025-05-13T06:01:48.501Z"
  }
 '
Content-Type: application/json
access_token: text
{
  "status": true,
  "code": "20000",
  "message": "OK",
  "data": true
}

1๋ถ„๋‹น 10,000๊ฑด

1์‹œ๊ฐ„๋‹น 100๊ฑด, ๋™์‹œ๊ฐ„ 5๊ฑด

์š”์ฒญ ์ œํ•œ ํ˜„ํ™ฉ์€ ์‘๋‹ต ํ—ค๋”์˜ ๊ฐ’์„ ํ†ตํ•ด ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

ํ—ค๋” ์ด๋ฆ„
์„ค๋ช…

X-Rate-Limit-Limit

์ดˆ๊ธฐํ™” ์ฃผ๊ธฐ

X-Rate-Limit-Remaining

๋‚จ์€ ์š”์ฒญ ํšŸ์ˆ˜

X-Rate-Limit-Reset

๋ฐœ์†ก ์†๋„๊ฐ€ ์ดˆ๊ธฐํ™”๋˜๋Š” ์‹œ๊ฐ„

Event

1๋ถ„๋‹น 1,000,000๊ฑด

Identity

1๋ถ„๋‹น 10,000๊ฑด

์š”์ฒญ ์ œํ•œ ์ •์ฑ…

curl -i https://openapi.dfinery.ai/api/v1/...
> HTTP/2 200
> x-ratelimit-limit: 1d
> x-ratelimit-remaining: 99999
> x-ratelimit-reset: 1682593200268
curl -i https://openapi.dfinery.ai/api/v1/...
> HTTP/2 429
> x-ratelimit-limit: 1d
> x-ratelimit-remaining: 0
> x-ratelimit-reset: 1682640000000

์š”์ฒญ ์ œํ•œ์„ ์ดˆ๊ณผํ•˜๋ฉด ์ดํ›„์˜ API ์š”์ฒญ์€ ๋ชจ๋‘ ์‹คํŒจํ•ฉ๋‹ˆ๋‹ค. ์ œํ•œ ์‹œ๊ฐ„์ด ์ง€๋‚˜ ์š”์ฒญ ์ œํ•œ์ด ์ดˆ๊ธฐํ™”๋œ ํ›„ ์ •์ƒ ์‘๋‹ต์„ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. API ์—ฐ๋™ ์‹œ ์š”์ฒญ ์ œํ•œ์„ ๊ณ ๋ คํ•˜์—ฌ ์—ฐ๋™ํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.

๊ธฐ๋ณธ์œผ๋กœ ์ œ๊ณต๋˜๋Š” ์š”์ฒญ ์ œํ•œ๋ณด๋‹ค ๋งŽ์€ ํ˜ธ์ถœ์ด ํ•„์š”ํ•˜๋‹ค๋ฉด ๊ณ ๊ฐ ์„ฑ๊ณตํŒ€์— ๋ฌธ์˜ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

์š”์ฒญ ์ œํ•œ ํ˜„ํ™ฉ ํ™•์ธ

X-Rate-Limit-Limit ์€ 1y: 1๋…„, 1M: 1๊ฐœ์›”, 1d: 1์ผ, 1H: 1์‹œ๊ฐ„, 1m: 1๋ถ„, 1s: 1์ดˆ๋กœ ๊ตฌ์„ฑ๋ฉ๋‹ˆ๋‹ค.

X-Rate-Limit-Rest ์€ Timestamp ํ˜•์‹์ž…๋‹ˆ๋‹ค. 1719397769

์š”์ฒญ ์ œํ•œ ํ˜„ํ™ฉ ์‘๋‹ต ์˜ˆ์‹œ

์ •์ƒ ์‘๋‹ต

API ํ˜ธ์ถœ ์ œํ•œ์„ ์ดˆ๊ณผํ•˜๋Š” ๊ฒฝ์šฐ (์‘๋‹ต ์ฝ”๋“œ 429)

์ƒ์„ธ ์‘๋‹ต

DFINERY Import API๋Š” HTTP ์‘๋‹ต ์ฝ”๋“œ์™€ ์ƒ์„ธ ์‘๋‹ต ์ฝ”๋“œ๋ฅผ ํ†ตํ•ด ์š”์ฒญ์˜ ์„ฑ๊ณต๊ณผ ์‹คํŒจ๋ฅผ ํŒ๋‹จํ•ฉ๋‹ˆ๋‹ค. HTTP ์‘๋‹ต ์ฝ”๋“œ๊ฐ€ 200 ์ด๋”๋ผ๋„, ์š”์ฒญ์€ ์‹คํŒจํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

HTTP ์‘๋‹ต ์ฝ”๋“œ

์‘๋‹ต ์ฝ”๋“œ
์„ค๋ช…

200 - OK

์„œ๋ฒ„์—์„œ ์ •์ƒ์ ์œผ๋กœ ์š”์ฒญ์„ ๋ฐ›์•˜์Šต๋‹ˆ๋‹ค.

400 - Bad Request

API ํ˜ธ์ถœ์ด ์‹คํŒจํ•œ ๊ฒฝ์šฐ, ์ƒ์„ธ ์‘๋‹ต ์ฝ”๋“œ๋ฅผ ํ†ตํ•ด ์˜ค๋ฅ˜์— ๋Œ€ํ•ด ์ƒ์„ธํ•œ ์ •๋ณด๋ฅผ ์–ป์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์‘๋‹ต ์ฝ”๋“œ
code
message
์„ค๋ช…

์ƒ์„ธ ์‘๋‹ต

DFINERY Export API๋Š” HTTP ์‘๋‹ต ์ฝ”๋“œ์™€ ์ƒ์„ธ ์‘๋‹ต ์ฝ”๋“œ๋ฅผ ํ†ตํ•ด ์š”์ฒญ์˜ ์„ฑ๊ณต๊ณผ ์‹คํŒจ๋ฅผ ํŒ๋‹จํ•ฉ๋‹ˆ๋‹ค.

HTTP ์‘๋‹ต ์ฝ”๋“œ

์‘๋‹ต ์ฝ”๋“œ
์„ค๋ช…

200 - OK

์„œ๋ฒ„์—์„œ ์ •์ƒ์ ์œผ๋กœ ์š”์ฒญ์„ ๋ฐ›์•˜์Šต๋‹ˆ๋‹ค.

400 - Bad Request

์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ๋ณด๋‚ด์ง€ ์•Š์•˜๊ฑฐ๋‚˜, ํŒŒ๋ผ๋ฏธํ„ฐ ํฌ๋งท์ด ์ž˜๋ชป๋˜์—ˆ์„ ๋•Œ ๋Œ์•„์˜ค๋Š” ์‘๋‹ต์ž…๋‹ˆ๋‹ค. ์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ํ™•์ธํ•ด ์ฃผ์„ธ์š”.

API ํ˜ธ์ถœ์ด ์‹คํŒจํ•œ ๊ฒฝ์šฐ, ์ƒ์„ธ ์‘๋‹ต ๊ฒฐ๊ณผ๋ฅผ ํ†ตํ•ด ์˜ค๋ฅ˜์— ๋Œ€ํ•ด ์ƒ์„ธํ•œ ์ •๋ณด๋ฅผ ์–ป์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์‘๋‹ต ์ฝ”๋“œ
result
message
์„ค๋ช…
ํ•ด๊ฒฐ ๋ฐฉ๋ฒ•

์„ฑ๊ณต ์‹œ ํ—ค๋”๋ฅผ ํฌํ•จํ•œ csvํฌ๋งท์˜ ๋ฐ์ดํ„ฐ๋ฅผ ์‘๋‹ต์œผ๋กœ ๋ฐ›๊ฒŒ ๋ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ์‚ฌํ•ญ์€ ๊ฐ ๋ฅผ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

POST: ์œ ์ € ์†์„ฑ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ

POST /api/v1/user-profile

๊ณ ๊ฐ์˜ ์œ ์ € ์†์„ฑ์„ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธํ•  ์ˆ˜ ์žˆ๋Š” API์ž…๋‹ˆ๋‹ค.

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…
Profile
Export

BAD_REQUEST

์ž˜๋ชป๋œ ์š”์ฒญ

200

40001

VALIDATION_FAILURE

๊ฒ€์ฆ ์‹คํŒจ

200

40101

INVALID_SERVICE_ID

์ž˜๋ชป๋œ ์„œ๋น„์Šค ID

200

40201

INVALID_TOKEN

์ž˜๋ชป๋œ ํ† ํฐ ์ œ๊ณต

200

40401

TOO_MANY_REQUEST

API ์‚ฌ์šฉ ํ•œ๋„ ์ดˆ๊ณผ

200

40402

TOO_MANY_EVENTS

์š”์ฒญ ๋‚ด ์ด๋ฒคํŠธ ์ˆ˜ ์ดˆ๊ณผ

200

40403

TOO_MANY_USER_PROFILES

๋‹จ์ผ ์š”์ฒญ ๋‚ด ์œ ์ € ํ”„๋กœํ•„ ์ˆ˜ ์ดˆ๊ณผ

200

50000

INTERNAL_SERVER_ERROR

์„œ๋ฒ„ ๋‚ด๋ถ€ ์—๋Ÿฌ ๋ฐœ์ƒ

์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ๋ณด๋‚ด์ง€ ์•Š์•˜๊ฑฐ๋‚˜, ํŒŒ๋ผ๋ฏธํ„ฐ ํฌ๋งท์ด ์ž˜๋ชป๋˜์—ˆ์„ ๋•Œ ๋Œ์•„์˜ค๋Š” ์‘๋‹ต์ž…๋‹ˆ๋‹ค. ์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ํ™•์ธํ•ด ์ฃผ์„ธ์š”.

429 - Too Many Requests

๋น„์ •์ƒ์ ์œผ๋กœ ๋งŽ์€ ์š”์ฒญ์„ ๋ณด๋ƒˆ์Šต๋‹ˆ๋‹ค. ์ž ์‹œ ํ›„ ๋‹ค์‹œ ์‹œ๋„ํ•ด ์ฃผ์„ธ์š”.

500 - Server Error

์„œ๋ฒ„ ๋‚ด๋ถ€์—์„œ ์—๋Ÿฌ๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค

200

20000

OK

์š”์ฒญ ์„ฑ๊ณต

200

์ƒ์„ธ ์‘๋‹ต ์ฝ”๋“œ

์‘๋‹ต ์˜ˆ์‹œ

20000 OK

40001 VALIDATION_FAILURE

50000 INTERNAL_SERVER_ERROR

40000

400

fail

invalid_parameter

์ œ๊ณต๋œ ์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ์ž˜๋ชป๋˜์—ˆ๊ฑฐ๋‚˜ ํ˜•์‹์ด ๋งž์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ์˜ ํ˜•์‹๊ณผ ๊ฐ’์„ ๊ฒ€ํ† ํ•˜๊ณ  ์˜ฌ๋ฐ”๋ฅด๊ฒŒ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.

400

fail

exceed_date_range_limit

์š”์ฒญํ•œ ์‹œ์ž‘์ผ์ด ํ—ˆ์šฉ๋œ ๋ฒ”์œ„๋ฅผ ์ดˆ๊ณผํ•˜์˜€์Šต๋‹ˆ๋‹ค.

์š”์ฒญํ•œ ์‹œ์ž‘์ผ์„ ์ตœ์†Œ 30์ผ ์ด๋‚ด์˜ ๋‚ ์งœ๋กœ ์กฐ์ •ํ•œ ํ›„ ๋‹ค์‹œ ์‹œ๋„ํ•ฉ๋‹ˆ๋‹ค.

401

fail

unauthorized_token

์œ ํšจํ•˜์ง€ ์•Š์€ Export ํ† ํฐ์ž…๋‹ˆ๋‹ค.

์ƒˆ๋กœ์šด ์œ ํšจํ•œ ํ† ํฐ์„ ๋ฐœ๊ธ‰๋ฐ›์•„ ์š”์ฒญ์„ ๋‹ค์‹œ ์‹œ๋„ํ•ฉ๋‹ˆ๋‹ค.

429

fail

too_many_api_requests

์š”์ฒญํ•œ API ํ˜ธ์ถœ ์ˆ˜๊ฐ€ ํ•œ๋„๋ฅผ ์ดˆ๊ณผํ–ˆ์Šต๋‹ˆ๋‹ค.

์ดˆ๊ณผ ๋ฒ”์œ„ ๋‚ด์—์„œ ์š”์ฒญ์„ ๋‹ค์‹œ ์‹œ๋„ํ•ฉ๋‹ˆ๋‹ค.

500

fail

unknown_error

์‹œ์Šคํ…œ ๋‚ด๋ถ€์—์„œ ์˜ˆ๊ธฐ์น˜ ์•Š์€ ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค.

์‹œ์Šคํ…œ ๋กœ๊ทธ๋ฅผ ํ™•์ธ ํ›„ ์›์ธ์„ ๋ถ„์„ํ•ฉ๋‹ˆ๋‹ค. ์˜ค๋ฅ˜๊ฐ€ ์ง€์†๋˜๋ฉด ๋ฌธ์˜ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

500

fail

query_error

์š”์ฒญ๋œ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ์ฟผ๋ฆฌ๊ฐ€ ์‹คํ–‰๋˜์ง€ ์•Š๊ณ , ์‹คํŒจํ•˜์˜€์Šต๋‹ˆ๋‹ค.

์‹œ์Šคํ…œ ๋กœ๊ทธ๋ฅผ ํ™•์ธ ํ›„ ์›์ธ์„ ๋ถ„์„ํ•ฉ๋‹ˆ๋‹ค. ์˜ค๋ฅ˜๊ฐ€ ์ง€์†๋˜๋ฉด ๋ฌธ์˜ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

429 - Too Many Requests

๋น„์ •์ƒ์ ์œผ๋กœ ๋งŽ์€ ์š”์ฒญ์„ ๋ณด๋ƒˆ์Šต๋‹ˆ๋‹ค. ์ž ์‹œ ํ›„ ๋‹ค์‹œ ์‹œ๋„ํ•ด ์ฃผ์„ธ์š”.

500 - Server Error

์„œ๋ฒ„ ๋‚ด๋ถ€์—์„œ ์—๋Ÿฌ๊ฐ€ ๋ฐœ์ƒํ–ˆ์Šต๋‹ˆ๋‹ค

200

fail

client_connection_closed

ํด๋ผ์ด์–ธํŠธ ์—ฐ๊ฒฐ์ด ์ข…๋ฃŒ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

ํด๋ผ์ด์–ธํŠธ ๋„คํŠธ์›Œํฌ ์ƒํƒœ๋ฅผ ์ ๊ฒ€ํ•˜๊ณ , ์›์ธ์„ ๋ถ„์„ํ•˜์—ฌ ์žฌ์‹œ๋„ํ•ฉ๋‹ˆ๋‹ค.

์ƒ์„ธ ์‘๋‹ต

์‘๋‹ต ์˜ˆ์‹œ

์„ฑ๊ณต

exceed_date_range_limit

unknown_error

API ๋ฌธ์„œ
200 OK
{
  "status": true,
  "code": 20000,
  "message": "OK",
  "data": null 
}
200 OK
{
  "status": false,
  "code": 40001,
  "message": "VALIDATION_FAILURE",
  "data": null 
}
200 OK
{
  "status": false,
  "code": 50000,
  "message": "INTERNAL_SERVER_ERROR",
  "data": null 
}
400 BAD REQUEST
{
    "result": "fail",
    "message": "exceed_date_range_limit"
}
500 INTERNAL_SERVER_ERROR
{
    "result": "fail",
    "message": "unknown_error"
}

service_id

ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…

Content-Type

ํ•„์ˆ˜

String

application/json

-

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

ํ•„์ˆ˜

Object

์œ ์ € ์‹๋ณ„์ž

์œ ์ € ์‹๋ณ„์ž ์ •๋ณด์ž…๋‹ˆ๋‹ค. ์•„๋ž˜ ํ•„๋“œ ์ค‘ ์ ์–ด๋„ ํ•˜๋‚˜์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

external_id

์„ ํƒ

String

์™ธ๋ถ€ ID

phone_no

์œ ์ € ์†์„ฑ์ž…๋‹ˆ๋‹ค. ํ•„๋“œ๋ช…์€ ์ฝ˜์†”์—์„œ ์‚ฌ์ „ ๋“ฑ๋ก๋œ ์œ ์ € ์†์„ฑ์˜ ์†์„ฑ๋ช…์„, ๊ฐ’์€ ํ•ด๋‹น ์†์„ฑ์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์‚ฌ์ „ ๋“ฑ๋ก๋œ ์œ ์ € ์†์„ฑ์˜ ์ข…๋ฅ˜๋Š” ์•„๋ž˜์™€ ๊ฐ™์Šต๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

${your-user-property-key}

์„ ํƒ

String, Long, Double, Boolean, Datetime, Array

์‚ฌ์ „ ๋“ฑ๋ก๋œ ์œ ์ € ์†์„ฑ ์ •๋ณด

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ƒ์„ธ ์‘๋‹ต ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์œ ์ € ์†์„ฑ์˜ ์ƒ์„ฑ ๋ฐ ์—…๋ฐ์ดํŠธ API ํ˜ธ์ถœ์€ ์œ ์ €์˜ ์†์„ฑ์˜ ๋ณ€๊ฒฝ ์‹œ์ ์—๋งŒ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค. ์—ฐ๋™ ์‹œ์—๋Š” ํ•ญ์ƒ ์š”์ฒญ ์ œํ•œ์„ ๊ณ ๋ คํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

curl -L \
  -X POST \
  -H 'access_token: ${your-import-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/user-profile?service_id=${your-service-id}' \
  -d '{
  "identity": {
    "external_id": "dfn-user-123"
  },
  "user_properties": {
    "df_gender": "Female"
  },
  "request_datetime": "2024-05-14T06:05:46.363Z"
}
 '
Content-Type: application/json
access_token: text
{
  "status": true,
  "code": "20000",
  "message": "OK",
  "data": true
}

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

identity

user_properties

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์ •์ƒ ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

POST: ์œ ์ € ํ”„๋กœํ•„ ์ถ”์ถœ

POST api/v1/export/userprofile

์ ์žฌ๋˜์–ด์žˆ๋Š” ์œ ์ € ํ”„๋กœํ•„์„ ์ถ”์ถœํ•  ์ˆ˜ ์žˆ๋Š” API ์ž…๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์œ ์ € ํ”„๋กœํ•„ ์ถ”์ถœ์˜ ์‘๋‹ต์€ , ๋กœ ๊ตฌ๋ถ„๋˜๋Š” ํ—ค๋”๊ฐ€ ํฌํ•จ๋œ csv ํฌ๋งท์ž…๋‹ˆ๋‹ค. ์ฒซ๋ฒˆ์งธ ์ค„์ด ํ—ค๋”์ด๊ณ , ๋‘๋ฒˆ์งธ ์ค„๋ถ€ํ„ฐ ์ถ”์ถœ๋œ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค. ์•„๋ž˜์˜ ํ‘œ๋Š” ์ฃผ์š” ํ—ค๋”์— ๋Œ€ํ•œ ์„ค๋ช…์ž…๋‹ˆ๋‹ค.

ํ†ตํ•ฉID์˜ ๊ฒฝ์šฐ properties, properties_condition_type, identities, identities_condition_type ์— ์ƒ๊ด€์—†์ด ์‘๋‹ต์— ํ•ญ์ƒ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ์„ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
๊ตฌ๋ถ„
์„ค๋ช…

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

Authorization

ํ•„์ˆ˜

String

Bearer your-auth-token

API ์ธ์ฆ ํ† ํฐ

String

ํ•„ํ„ฐ๋ง ์—ฐ์‚ฐ์ž, ์•„๋ž˜ ๊ฐ’์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

all : ์ „์ฒด ์œ ์ € ์†์„ฑ,

include : properties์˜ ์œ ์ € ์†์„ฑ๋งŒ ํฌํ•จ,

exclude : properties์˜ ์œ ์ € ์†์„ฑ ์ œ์™ธ

identities

์„ ํƒ

List of String

ํ•„ํ„ฐ๋ง ๋Œ€์ƒ ์‹๋ณ„ ์†์„ฑ๋ช… ๋ฆฌ์ŠคํŠธ, ๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๋ชจ๋“  ์‹๋ณ„ ์†์„ฑ ์ถ”์ถœ

identities_condition_type

์„ ํƒ

String

ํ•„ํ„ฐ๋ง ์—ฐ์‚ฐ์ž, ์•„๋ž˜ ๊ฐ’์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. ๊ธฐ๋ณธ๊ฐ’์€ include์ž…๋‹ˆ๋‹ค.

all : ์ „์ฒด ์‹๋ณ„ ์†์„ฑ,

include : identities์˜ ์‹๋ณ„ ์†์„ฑ๋งŒ ํฌํ•จ,

exclude : identities์˜ ์‹๋ณ„ ์†์„ฑ ์ œ์™ธ

audience

์„ ํƒ

String

์ถ”์ถœํ•˜๊ณ ์ž ํ•˜๋Š” ์œ ์ €๊ฐ€ ํฌํ•จ๋œ ์˜ค๋””์–ธ์ŠคID, ๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๋ชจ๋“  ์œ ์ €์— ๋Œ€ํ•ด ์ถ”์ถœ

${your-standard-user-property-key}

ํ‘œ์ค€ ์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ

ํ‘œ์ค€ ์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

${your-custom-user-property-key}

์ปค์Šคํ…€ ์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ

์ปค์Šคํ…€์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

service_id

ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

Content-Type

ํ•„์ˆ˜

String

application/json

-

properties

์„ ํƒ

List of String

ํ•„ํ„ฐ๋ง ๋Œ€์ƒ ์œ ์ € ์†์„ฑ๋ช… ๋ฆฌ์ŠคํŠธ, ๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๋ชจ๋“  ์œ ์ € ์†์„ฑ ์ถ”์ถœ

properties_condition_type

df_unified_id

ํ†ตํ•ฉID

ํ†ตํ•ฉID

${your-identity-property-key}

์‹๋ณ„ ์†์„ฑ

์‹๋ณ„ ์†์„ฑ

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

ํ˜„์žฌ ์‹๋ณ„ ์†์„ฑ์— ๋Œ€ํ•œ ์ถ”์ถœ์€ ์™ธ๋ถ€ID(df_external_id) ๋งŒ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. identities_condition_type ์˜ ๊ฐ’์ด all ์ด๋”๋ผ๋„, ์™ธ๋ถ€ID (df_external_id) ๋งŒ ์ถ”์ถœ๋ฉ๋‹ˆ๋‹ค.

์‘๋‹ต

ํ˜„์žฌ ์‹๋ณ„ ์†์„ฑ์— ๋Œ€ํ•œ ์ถ”์ถœ์€ ์™ธ๋ถ€ID(df_external_id) ๋งŒ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. identities_condition_type ์˜ ๊ฐ’์ด all ์ด๋”๋ผ๋„, ์™ธ๋ถ€ID (df_external_id) ๋งŒ ์ถ”์ถœ๋ฉ๋‹ˆ๋‹ค.

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์„ฑ๊ณต ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

ํ‘œ์ค€ ์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ ๋ชฉ๋ก
์ƒ์„ธ ์‘๋‹ต
ํ•„์ˆ˜
curl -L \
  -X POST \
  -H 'Authorization: Bearer ${your-export-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/export/userprofile?service_id=${your-service-id}' \
  -d '{
    "audience": "nwh3nu",
    "properties_condition_type": "exclude",
    "properties": [
        "df_birth"
    ],
    "identities": ["df_external_id"],
    "identities_condition_type": "include"
}'
custom_user_datetime,df_gender,df_kakao_ads_optin,df_membership,df_push_ads_optin,df_push_night_ads_optin,df_push_optin,df_sms_ads_optin,df_unified_id,scenario_list_string
,Male,false,,true,false,true,false,ZCUyK5F,"[""1"",""2""]"
,,false,,false,false,false,false,xrx4ib2,null
,,false,,false,false,true,false,BWCExSV,null
,,false,,false,false,false,false,uZFjOE3,null

access_token

ํ•„์ˆ˜

String

your-api-token-key

API ์ธ์ฆ ํ† ํฐ

ํ•„์ˆ˜

Object

์œ ์ € ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ UTC ํƒ€์ž„์กด ๊ธฐ์ค€

request_datetime

ํ•„์ˆ˜

Datetime

์š”์ฒญ ์‹œ๊ฐ, ISODate 8601 Format, UTC ํƒ€์ž„์กด ๊ธฐ์ค€ 2024-06-24T06:42:25.394Z

์„ ํƒ

String

์ „ํ™” ๋ฒˆํ˜ธ

email

์„ ํƒ

String

์ด๋ฉ”์ผ

kakao_user_id

์„ ํƒ

String

์นด์นด์˜ค ID

line_user_id

์„ ํƒ

String

๋ผ์ธ ID

identity
user_properties

POST: ์ด๋ฒคํŠธ ์ ์žฌ

POST /api/v1/events

์ด๋ฒคํŠธ ์ ์žฌ API๋ฅผ ํ†ตํ•ด ํ•˜๋‚˜ ํ˜น์€ ์—ฌ๋Ÿฌ ์ด๋ฒคํŠธ๋ฅผ ํ•œ๋ฒˆ์— ์ ์žฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ ์žฌํ•˜๊ณ ์ž ํ•˜๋Š” ์ด๋ฒคํŠธ๋Š” ์ฝ˜์†”์—์„œ ์‚ฌ์ „ ๋“ฑ๋ก๋˜์–ด ์žˆ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํ•œ๋ฒˆ์˜ ์š”์ฒญ์—์„œ ์ตœ๋Œ€ 100๊ฐœ์˜ ์ด๋ฒคํŠธ๋ฅผ ์ ์žฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ, ํ•œ๋ฒˆ์˜ ์š”์ฒญ์—์„œ ์ตœ๋Œ€ 100๊ฐœ์˜ ์ด๋ฒคํŠธ ์•„์ดํ…œ์„ ์ ์žฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋งŽ์€ ์ด๋ฒคํŠธ๋ฅผ ์ ์žฌ ํ•ด์•ผ ํ•œ๋‹ค๋ฉด, ๊ฐœ๋ณ„๋กœ ์ด๋ฒคํŠธ ์ ์žฌ API๋ฅผ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ ๋ณด๋‹ค ์—ฌ๋Ÿฌ ์ด๋ฒคํŠธ๋ฅผ ๋ชจ์•„๋‘์—ˆ๋‹ค๊ฐ€ ํ•œ๋ฒˆ์— ์ด๋ฒคํŠธ ์ ์žฌ API๋ฅผ ํ˜ธ์ถœํ•˜๋Š” ๊ฒƒ์ด ์†๋„ ๋ฐ ์š”์ฒญ ์ œํ•œ ์ธก๋ฉด์—์„œ ์ข‹์Šต๋‹ˆ๋‹ค. ์—ฐ๋™ ์‹œ์—๋Š” ํ•ญ์ƒ ์„ ๊ณ ๋ คํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์œ ์ € ์‹๋ณ„์ž ์ •๋ณด์ž…๋‹ˆ๋‹ค. ์•„๋ž˜ ํ•„๋“œ ์ค‘ ์ ์–ด๋„ ํ•˜๋‚˜์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์ด๋ฒคํŠธ ์ •๋ณด์ž…๋‹ˆ๋‹ค. ์ ์žฌํ•˜๊ณ ์ž ํ•˜๋Š” ์ด๋ฒคํŠธ๋Š” ์ฝ˜์†”์—์„œ ์‚ฌ์ „ ๋“ฑ๋ก๋˜์–ด ์žˆ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ํ‘œ์ค€ ์ด๋ฒคํŠธ์™€ ์ด๋ฒคํŠธ ์†์„ฑ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ์‚ฌ์šฉ์ž ๊ฐ€์ด๋“œ์˜ ๋ฅผ ์ฐธ๊ณ ํ•ด ์ฃผ์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์ด๋ฒคํŠธ ์•„์ดํ…œ ์†์„ฑ์ž…๋‹ˆ๋‹ค. ํ•„๋“œ๋ช…์€ ์ฝ˜์†”์—์„œ ์‚ฌ์ „ ๋“ฑ๋ก๋œ ์•„์ดํ…œ(df_item) ์˜ ํ•˜์œ„ ์†์„ฑ๋ช…์„, ๊ฐ’์€ ํ•ด๋‹น ์†์„ฑ์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ด๋ฒคํŠธ ์•„์ดํ…œ์€ ํ•œ๋ฒˆ์— ์ตœ๋Œ€ 100๊ฐœ๊นŒ์ง€ ์ ์žฌ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์ด๋ฒคํŠธ ์†์„ฑ์ž…๋‹ˆ๋‹ค. ํ•„๋“œ๋ช…์€ ์•„์ดํ…œ(df_item) ์„ ์ œ์™ธํ•œ ์ฝ˜์†”์—์„œ ์‚ฌ์ „ ๋“ฑ๋ก๋œ ์ด๋ฒคํŠธ ์†์„ฑ์˜ ์†์„ฑ๋ช…์„, ๊ฐ’์€ ํ•ด๋‹น ์†์„ฑ์˜ ๊ฐ’์„ ๋„ฃ์–ด์ฃผ์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ์ˆ˜๊ฐ€ 100๊ฐœ๋ฅผ ์ดˆ๊ณผํ•˜๊ฑฐ๋‚˜, ์ด๋ฒคํŠธ ์•„์ดํ…œ ์ˆ˜๊ฐ€ 100๊ฐœ๋ฅผ ์ดˆ๊ณผํ•œ ๊ฒฝ์šฐ์ž…๋‹ˆ๋‹ค.

POST: ์ด๋ฒคํŠธ ์ถ”์ถœ

POST api/v1/export/event

์ ์žฌ๋˜์–ด์žˆ๋Š” ์ด๋ฒคํŠธ๋ฅผ ์ถ”์ถœํ•  ์ˆ˜ ์žˆ๋Š” API ์ž…๋‹ˆ๋‹ค.

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

access_token

ํ•„์ˆ˜

String

your-api-token-key

API ์ธ์ฆ ํ† ํฐ

Array of Object

์ด๋ฒคํŠธ ์ •๋ณด

String

์ „ํ™” ๋ฒˆํ˜ธ

email

์„ ํƒ

String

์ด๋ฉ”์ผ

kakao_user_id

์„ ํƒ

String

์นด์นด์˜ค ID

line_user_id

์„ ํƒ

String

๋ผ์ธ ID

String

์ด๋ฒคํŠธ๋ช…

event_datetime

ํ•„์ˆ˜

Datetime

์ด๋ฒคํŠธ ๋ฐœ์ƒ ์‹œ๊ฐ, UTC ํƒ€์ž„์กด ๊ธฐ์ค€

์„ ํƒ

Array of Object

์ƒํ’ˆ ์ •๋ณด, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ UTC ํƒ€์ž„์กด ๊ธฐ์ค€

์„ ํƒ

Object

์ด๋ฒคํŠธ ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ UTC ํƒ€์ž„์กด ๊ธฐ์ค€

service_id

ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

Content-Type

ํ•„์ˆ˜

String

application/json

-

common

ํ•„์ˆ˜

Object

์ด๋ฒคํŠธ ์ ์žฌ๋ฅผ ์œ„ํ•œ ๊ณตํ†ต ์†์„ฑ

events

identity

ํ•„์ˆ˜

Object

์œ ์ € ์‹๋ณ„์ž

external_id

์„ ํƒ

String

์™ธ๋ถ€ ID

phone_no

event_log_id

ํ•„์ˆ˜

String

์ด๋ฒคํŠธ ์‹๋ณ„ ID, UUID Format, xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx

event_name

${your-df-item-property-key}

์„ ํƒ

String, Long, Double, Boolean, Datetime, Array

์‚ฌ์ „ ๋“ฑ๋ก๋œ ์ด๋ฒคํŠธ ์•„์ดํ…œ ์†์„ฑ ์ •๋ณด

${your-event-property-key}

์„ ํƒ

String, Long, Double, Boolean, Datetime, Array

์‚ฌ์ „ ๋“ฑ๋ก๋œ ์ด๋ฒคํŠธ ์†์„ฑ ์ •๋ณด

curl -L \
  -X POST \
  -H 'access_token: ${your-import-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/events?service_id=${your-service-id}' \
  -d '{
  "common": {
    "identity": {
      "external_id": "dfn-user-123",
      "email": "dfn@gmail.com"
    }
  },
  "events": [
    {
      "event_log_id": "b0c9cf18-f3c0-4879-bb2e-92c65858dabc",
      "event_name": "df_login",
      "event_datetime": "2024-06-24T06:01:48.501Z",
      "event_properties": null,
      "event_items": null
    },
    {
      "event_log_id": "464bc021-9c56-481e-8ee8-3bf06de7c418",
      "event_name": "df_purchase",
      "event_datetime": "2024-06-24T06:42:25.394Z",
      "event_properties": {
        "df_order_id": "dwtfmoe",
        "df_delivery_charge": 1000,
        "df_payment_method": "card",
        "df_total_purchase_amount": 4000
      },
      "event_items": [
        {
          "df_item_id": "1",
          "df_item_name": "item1",
          "df_price": 3000,
          "df_quantity": 1,
          "df_discount": 0
        }
      ]
    }
  ]
}'
Content-Type: application/json
access_token: ${your-api-token}
{
  "status": true,
  "code": "20000",
  "message": "OK",
  "data": true
}
Content-Type: application/json
access_token: ${your-api-token}
{
  "status": false,
  "code": "40402",
  "message": "TOO_MANY_EVENTS",
  "data": true
}

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

common

identity

events

event_items

event_properties

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์ •์ƒ ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

40402 TOO_MANY_EVENTS

์ด๋ฒคํŠธ ํ…์†Œ๋…ธ๋ฏธ ์„ค๊ณ„ํ•˜๊ธฐ
์ƒ์„ธ ์‘๋‹ต
์š”์ฒญ ์ œํ•œ
ํ•„์ˆ˜
์„ ํƒ
ํ•„์ˆ˜
ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…

Content-Type

ํ•„์ˆ˜

String

application/json

-

ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

events

์„ ํƒ

List of String

ํ•„ํ„ฐ๋ง ๋Œ€์ƒ ์ด๋ฒคํŠธ๋ช… ๋ฆฌ์ŠคํŠธ, ๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๋ชจ๋“  ์ด๋ฒคํŠธ ์ถ”์ถœ

events_condition_type

์ด๋ฒคํŠธ ์ถ”์ถœ์˜ ์‘๋‹ต์€ , ๋กœ ๊ตฌ๋ถ„๋˜๋Š” ํ—ค๋”๊ฐ€ ํฌํ•จ๋œ csv ํฌ๋งท์ž…๋‹ˆ๋‹ค. ์ฒซ๋ฒˆ์งธ ์ค„์ด ํ—ค๋”์ด๊ณ , ๋‘๋ฒˆ์งธ ์ค„๋ถ€ํ„ฐ ์ถ”์ถœ๋œ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค. ์•„๋ž˜์˜ ํ‘œ๋Š” ์ฃผ์š” ํ—ค๋”์— ๋Œ€ํ•œ ์„ค๋ช…์ž…๋‹ˆ๋‹ค.

ํ†ตํ•ฉID์™€ ์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ์˜ ๊ฒฝ์šฐ properties, properties_condition_type ์— ์ƒ๊ด€์—†์ด ์‘๋‹ต์— ํ•ญ์ƒ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๊ธฐ๋ณธ๊ฐ’์€ ๋นˆ ๊ฐ’(empty) ์ž…๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ์†์„ฑ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ด๋ฒคํŠธ ํƒ์†Œ๋…ธ๋ฏธ ์„ค๊ณ„ํ•˜๊ธฐ ๋ฅผ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
๊ตฌ๋ถ„
์„ค๋ช…

df_unified_id

ํ†ตํ•ฉID

ํ†ตํ•ฉID

${your-standard-event-property-key}

ํ‘œ์ค€ ์ด๋ฒคํŠธ ์†์„ฑ

ํ‘œ์ค€ ์ด๋ฒคํŠธ ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ƒ์„ธ ์‘๋‹ต ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ๋ฐ์ดํ„ฐ ์ถ”์ถœ์€ ํ˜„์žฌ ๋‚ ์งœ๋กœ๋ถ€ํ„ฐ 365์ผ ์ด์ „ ๋ฐ์ดํ„ฐ๊นŒ์ง€๋งŒ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ๋ฐ์ดํ„ฐ ์ถ”์ถœ ๊ธฐ๊ฐ„์€ ์ตœ๋Œ€ 31์ผ์ž…๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

service_id

curl -L \
  -X POST \
  -H 'Authorization: Bearer ${your-export-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/export/event?service_id=${your-service-id}' \
  -d '{
    "events": ["df_purchase"],
    "events_condition_type": "include",
    "properties": ["df_discount", "df_items_df_price"],
    "properties_condition_type": "include",
    "from_date": "2024-08-25",
    "to_date": "2024-08-26"
}' -o results.csv
200 OK

custom_012,custom_event_p_boolean,custom_event_p_datetime,custom_event_p_double,custom_event_p_double_list,custom_event_p_long,custom_event_p_long_list,custom_event_p_string_list,df_api_version,df_correction_datetime,df_delivery_charge,df_discount,df_event_datetime,df_event_detail_log_id,df_event_log_id,df_event_name,df_items_custom_012391239128,df_items_custom_item_boolean,df_items_custom_item_datetime,df_items_custom_item_double,df_items_custom_item_double_list,df_items_custom_item_long,df_items_custom_item_long_list,df_items_custom_item_string,df_items_custom_item_string_list,df_items_df_category1,df_items_df_category2,df_items_df_category3,df_items_df_category4,df_items_df_category5,df_items_df_discount,df_items_df_item_id,df_items_df_item_name,df_items_df_price,df_items_df_quantity,df_keyword,df_order_id,df_payment_method,df_server_datetime,df_service_id,df_sharing_channel,df_sign_channel,df_source_type,df_total_purchase_amount,df_total_refund_amount,df_unified_id,sum
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:35,,,2025.1.6 10:35,1736127307268:1736127306623:cd20207c-bb2a-4abf-a4a9-80804334cf15,1736127307268:1736127306623:cd20207c-bb2a-4abf-a4a9-80804334cf15,df_end_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:35,xyroon,,,SDK,,,7jPY23Q,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:35,,,2025.1.6 10:35,1736127307268:1736127306638:19c95a76-868b-49bc-a8a5-68058377342f,1736127307268:1736127306638:19c95a76-868b-49bc-a8a5-68058377342f,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:35,xyroon,,,SDK,,,7jPY23Q,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:38,,,2025.1.6 10:38,1736127490036:30873a05-62d3-4007-b643-f500a151be24,1736127490036:30873a05-62d3-4007-b643-f500a151be24,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025-01-06 10:38:10.036,xyroon,,,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:38,,,2025.1.6 10:38,1736127513890:1d302d2c-e66e-4e7b-ba1d-94299a18c218,1736127513890:1d302d2c-e66e-4e7b-ba1d-94299a18c218,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:38,xyroon,,,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:38,,,2025.1.6 10:38,1736127521375:0ae48e8f-05f5-48aa-acdd-0ce9c1d62631,1736127521375:0ae48e8f-05f5-48aa-acdd-0ce9c1d62631,df_sign_up,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:38,xyroon,,Kakao,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:38,,,2025.1.6 10:38,1736127534688:10ce7ebd-ac54-4bbd-bd75-1e15c3ff92b6,1736127534688:10ce7ebd-ac54-4bbd-bd75-1e15c3ff92b6,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:38,xyroon,,,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:47,,,2025.1.6 10:47,1736128036788:e90f4559-666c-4b04-9f1b-846c55f3b12d,1736128036788:e90f4559-666c-4b04-9f1b-846c55f3b12d,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:47,xyroon,,,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:47,,,2025.1.6 10:47,1736128047673:c62a93ed-4979-4307-b2d5-cbcc3f46578e,1736128047673:c62a93ed-4979-4307-b2d5-cbcc3f46578e,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:47,xyroon,,,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:47,,,2025.1.6 10:47,1736128055767:95d77aa8-0bf2-4967-908b-0ac60987e250,1736128055767:95d77aa8-0bf2-4967-908b-0ac60987e250,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:47,xyroon,,,SDK,,,vft57Yw,
,FALSE,,,null,,null,null,1.0.0,2025.1.6 10:47,,,2025.1.6 10:47,1736128058570:a68f6530-6496-48c1-b6bb-4593d03b140f,1736128058570:a68f6530-6496-48c1-b6bb-4593d03b140f,df_start_session,,FALSE,,,null,,null,,null,,,,,,,,,,,,,,2025.1.6 10:47,xyroon,,,SDK,,,vft57Yw,

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

์‘๋‹ต

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์„ฑ๊ณต ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

POST: ๋ฆฌํฌํŠธ ์ถ”์ถœ

POST api/v1/export/report

์ ์žฌ๋˜์–ด์žˆ๋Š” ์บ ํŽ˜์ธ ๋ฆฌํฌํŠธ๋ฅผ ์ถ”์ถœํ•  ์ˆ˜ ์žˆ๋Š” API ์ž…๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ๋ฐ์ดํ„ฐ ์ถ”์ถœ์€ ํ˜„์žฌ ๋‚ ์งœ๋กœ๋ถ€ํ„ฐ 365์ผ ์ด์ „ ๋ฐ์ดํ„ฐ๊นŒ์ง€๋งŒ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

์ด๋ฒคํŠธ ๋ฐ์ดํ„ฐ ์ถ”์ถœ ๊ธฐ๊ฐ„์€ ์ตœ๋Œ€ 31์ผ์ž…๋‹ˆ๋‹ค.

์ฟผ๋ฆฌ ํŒŒ๋ผ๋ฏธํ„ฐ

์ด๋ฆ„
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
๊ฐ’
์„ค๋ช…
ํ•„๋“œ๋ช…
ํ•„์ˆ˜๊ฐ’ ์—ฌ๋ถ€
ํƒ€์ž…
์„ค๋ช…

๋ฆฌํฌํŠธ ์ถ”์ถœ์˜ ์‘๋‹ต์€ , ๋กœ ๊ตฌ๋ถ„๋˜๋Š” ํ—ค๋”๊ฐ€ ํฌํ•จ๋œ csv ํฌ๋งท์ž…๋‹ˆ๋‹ค. ์ฒซ๋ฒˆ์งธ ์ค„์ด ํ—ค๋”์ด๊ณ , ๋‘๋ฒˆ์งธ ์ค„๋ถ€ํ„ฐ ์ถ”์ถœ๋œ ๋ฐ์ดํ„ฐ์ž…๋‹ˆ๋‹ค. ์•„๋ž˜์˜ ํ‘œ๋Š” ์ฃผ์š” ํ—ค๋”์— ๋Œ€ํ•œ ์„ค๋ช…์ž…๋‹ˆ๋‹ค.

๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๊ธฐ๋ณธ๊ฐ’์€ ๋นˆ ๊ฐ’(empty) ์ž…๋‹ˆ๋‹ค.

์•„๋ž˜๋Š” ์บ ํŽ˜์ธ ์œ ํ˜•๋ณ„ ์‘๋‹ต ์ƒ์„ธ์ž…๋‹ˆ๋‹ค.

ํ•„๋“œ๋ช…
ํƒ€์ž…
์„ค๋ช…
COMPLETION
CLICK
CONVERSION
ํ•„๋“œ๋ช…
ํƒ€์ž…
์„ค๋ช…
COMPLETION
CLICK
CONVERSION

์ž์„ธํ•œ ๋‚ด์šฉ์€ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

Authorization

ํ•„์ˆ˜

String

Bearer your-auth-token

API ์ธ์ฆ ํ† ํฐ

ํ•„์ˆ˜

String

ํ•„ํ„ฐ๋ง ์—ฐ์‚ฐ์ž, ์•„๋ž˜ ๊ฐ’์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

all : ์ „์ฒด ์ด๋ฒคํŠธ,

include : events์˜ ์ด๋ฒคํŠธ๋งŒ ํฌํ•จ,

exclude : events์˜ ์ด๋ฒคํŠธ ์ œ์™ธ

properties

์„ ํƒ

List of String

ํ•„ํ„ฐ๋ง ๋Œ€์ƒ ์ด๋ฒคํŠธ ์†์„ฑ ๋ฆฌ์ŠคํŠธ, ๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ๋ชจ๋“  ์ด๋ฒคํŠธ ์†์„ฑ ์ถ”์ถœ

properties_condition_type

์„ ํƒ

String

ํ•„ํ„ฐ๋ง ์—ฐ์‚ฐ์ž, ์•„๋ž˜ ๊ฐ’์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

๊ฐ’์ด ์กด์žฌํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ : ์ „์ฒด ์ด๋ฒคํŠธ ์†์„ฑ,

all : ์ „์ฒด ์ด๋ฒคํŠธ ์†์„ฑ,

include : properties์˜ ์ด๋ฒคํŠธ ์†์„ฑ๋งŒ ํฌํ•จ,

exclude : properties์˜ ์ด๋ฒคํŠธ ์†์„ฑ ์ œ์™ธ

from_date

ํ•„์ˆ˜

Date

์ด๋ฒคํŠธ ์กฐํšŒ ์‹œ์ž‘์ผ(yyyy-MM-dd), ์ถ”์ถœ๊ธฐ๊ฐ„์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. from_date์˜ 00์‹œ 00๋ถ„ <= ์ถ”์ถœ๊ธฐ๊ฐ„ < to_date ์˜ 00์‹œ 00๋ถ„

to_date

์„ ํƒ

Date

์ด๋ฒคํŠธ ์กฐํšŒ ์ข…๋ฃŒ์ผ(yyyy-MM-dd),์ถ”์ถœ๊ธฐ๊ฐ„์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. from_date์˜ 00์‹œ 00๋ถ„ <= ์ถ”์ถœ๊ธฐ๊ฐ„ < to_date ์˜ 00์‹œ 00๋ถ„, to_date ๋ฅผ ์ž…๋ ฅํ•˜์ง€ ์•Š์„ ์‹œ to_date๋Š” ํ˜„์žฌ ์‹œ๊ฐ„์ด ๋ฉ๋‹ˆ๋‹ค.

${your-custom-event-property-key}

์ปค์Šคํ…€ ์ด๋ฒคํŠธ ์†์„ฑ

์ปค์Šคํ…€ ์ด๋ฒคํŠธ ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

${your-df-item-property-key}

ํ‘œ์ค€, ์ปค์Šคํ…€ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ ์•„์ดํ…œ (ํ‘œ์ค€, ์ปค์Šคํ…€) ์†์„ฑ, Datetime ํƒ€์ž…์˜ ๊ฒฝ์šฐ ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

df_api_version

์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ API ๋ฒ„์ „

event_name

์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ๋ช…

df_server_datetime

์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ ๋กœ๊ทธ ์„œ๋ฒ„ ๋„๋‹ฌ ์‹œ๊ฐ, ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

df_correction_datetime

์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ ๋ฐœ์ƒ ์‹œ๊ฐ, ์„œ๋น„์Šค ํƒ€์ž„์กด ๊ธฐ์ค€

df_event_detail_log_id

์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ ๋กœ๊ทธ ID, ๊ตฌ๋งค ์ด๋ฒคํŠธ์—์„œ ์—ฌ๋Ÿฌ ์•„์ดํ…œ์ด ํฌํ•จ๋˜์–ด ์žˆ๋Š” ๊ฒฝ์šฐ,

${df_event_log_id}:${n} ์˜ ํ˜•ํƒœ์ž…๋‹ˆ๋‹ค.

df_event_log_id

์‹œ์Šคํ…œ ์ด๋ฒคํŠธ ์†์„ฑ

์ด๋ฒคํŠธ ๋กœ๊ทธ ID

event_items
event_properties

Authorization

ํ•„์ˆ˜

String

Bearer your-auth-token

API ์ธ์ฆ ํ† ํฐ

String

์บ ํŽ˜์ธ ์œ ํ˜•, ์•„๋ž˜ ๊ฐ’์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

OS_PUSH : OS ํ‘ธ์‹œ,

AD_PUSH : ๊ด‘๊ณ  ํ‘ธ์‹œ,

TEXT_MESSAGE : ๋ฌธ์ž,

KAKAO_ALIMTALK : ์นด์นด์˜ค ์•Œ๋ฆผํ†ก,

KAKAO_BRAND_MESSAGE : ์นด์นด์˜ค ๋ธŒ๋žœ๋“œ ๋ฉ”์‹œ์ง€,

report_type

ํ•„์ˆ˜

String

์บ ํŽ˜์ธ ๋ฆฌํฌํŠธ ํƒ€์ž…, ์•„๋ž˜ ๊ฐ’์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

COMPLETION : ์„ฑ๊ณต/์‹คํŒจ,

CLICK : ํด๋ฆญ,

CONVERSION : ๊ตฌ๋งค ๋ฐ ์ „ํ™˜

from_date

ํ•„์ˆ˜

Date

์ด๋ฒคํŠธ ์กฐํšŒ ์‹œ์ž‘์ผ(yyyy-MM-dd), ์ถ”์ถœ๊ธฐ๊ฐ„์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. from_date์˜ 00์‹œ 00๋ถ„ <= ์ถ”์ถœ๊ธฐ๊ฐ„ < to_date ์˜ 00์‹œ 00๋ถ„

to_date

์„ ํƒ

Date

์ด๋ฒคํŠธ ์กฐํšŒ ์ข…๋ฃŒ์ผ(yyyy-MM-dd),์ถ”์ถœ๊ธฐ๊ฐ„์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค. from_date์˜ 00์‹œ 00๋ถ„ <= ์ถ”์ถœ๊ธฐ๊ฐ„ < to_date ์˜ 00์‹œ 00๋ถ„, to_date ๋ฅผ ์ž…๋ ฅํ•˜์ง€ ์•Š์„ ์‹œ to_date๋Š” ํ˜„์žฌ ์‹œ๊ฐ„์ด ๋ฉ๋‹ˆ๋‹ค.

์ง€์›

campaign_id

String

์บ ํŽ˜์ธ ID

์ง€์›
์ง€์›
์ง€์›

campaign_name

String

์บ ํŽ˜์ธ ์ด๋ฆ„

์ง€์›
์ง€์›
์ง€์›

campaign_status

String

์บ ํŽ˜์ธ ์ƒํƒœ

์ง€์›
์ง€์›
์ง€์›

df_external_id

String

์™ธ๋ถ€ ID

์ง€์›
์ง€์›
์ง€์›

is_success

Boolean

๋ฐœ์†ก/์ฒ˜๋ฆฌ ์„ฑ๊ณต ์—ฌ๋ถ€

์ง€์›
๋ฏธ์ง€์›
๋ฏธ์ง€์›

result_message

String

๋ฐœ์†ก/์ฒ˜๋ฆฌ ๊ฒฐ๊ณผ ๋ฉ”์‹œ์ง€

์ง€์›
๋ฏธ์ง€์›
๋ฏธ์ง€์›

click

Long

ํด๋ฆญ

๋ฏธ์ง€์›
์ง€์›
๋ฏธ์ง€์›

purchase_count

Long

๊ตฌ๋งค ์ „ํ™˜ ์ˆ˜

๋ฏธ์ง€์›
๋ฏธ์ง€์›
์ง€์›

purchase_amount

Double

๊ตฌ๋งค ์ „ํ™˜ ๊ธˆ

๋ฏธ์ง€์›
๋ฏธ์ง€์›
์ง€์›
์ง€์›

journey_id

String

์บ ํŽ˜์ธ ์—ฌ์ • ID

์ง€์›
์ง€์›
์ง€์›

journey_name

String

์บ ํŽ˜์ธ ์—ฌ์ • ์ด๋ฆ„

์ง€์›
์ง€์›
์ง€์›

journey_status

String

์บ ํŽ˜์ธ ์—ฌ์ • ์ƒํƒœ

์ง€์›
์ง€์›
์ง€์›

node_id

String

์บ ํŽ˜์ธ ์—ฌ์ • ๋…ธ๋“œ ID

์ง€์›
์ง€์›
์ง€์›

node_name

String

์บ ํŽ˜์ธ ์—ฌ์ • ๋…ธ๋“œ ์ด๋ฆ„

์ง€์›
์ง€์›
์ง€์›

node_type

String

์บ ํŽ˜์ธ ์—ฌ์ • ๋…ธ๋“œ ํƒ€์ž…

์ง€์›
์ง€์›
์ง€์›

df_external_id

String

์™ธ๋ถ€ ID

์ง€์›
์ง€์›
์ง€์›

is_success

Boolean

๋ฐœ์†ก/์ฒ˜๋ฆฌ ์„ฑ๊ณต ์—ฌ๋ถ€

์ง€์›
๋ฏธ์ง€์›
๋ฏธ์ง€์›

result_message

String

๋ฐœ์†ก/์ฒ˜๋ฆฌ ๊ฒฐ๊ณผ ๋ฉ”์‹œ์ง€

์ง€์›
๋ฏธ์ง€์›
๋ฏธ์ง€์›

click

Long

ํด๋ฆญ

๋ฏธ์ง€์›
์ง€์›
๋ฏธ์ง€์›

purchase_count

Long

๊ตฌ๋งค ์ „ํ™˜ ์ˆ˜

๋ฏธ์ง€์›
๋ฏธ์ง€์›
์ง€์›

purchase_amount

Double

๊ตฌ๋งค ์ „ํ™˜ ๊ธˆ์•ก

๋ฏธ์ง€์›
๋ฏธ์ง€์›
์ง€์›

service_id

ํ•„์ˆ˜

String

์„œ๋น„์Šค ID

Content-Type

ํ•„์ˆ˜

String

application/json

-

campaign_id

ํ•„์ˆ˜

String

์บ ํŽ˜์ธ ID

campaign_type

report_datetime

Datetime

๋ฆฌํฌํŠธ ์‹œ

์ง€์›

report_datetime

Datetime

๋ฆฌํฌํŠธ ์‹œ

์ง€์›
curl -L \
  -X POST \
  -H 'Authorization: Bearer ${your-export-api-token}' \
  -H 'Content-Type: application/json' \
  'https://openapi.dfinery.ai/api/v1/export/report?service_id=${your-service-id}' \
  -d '{
    "campaign_id": "dfinery",
    "campaign_type": "JOURNEY",
    "report_type": "CONVERSION",
    "from_date": "2026-05-01",
    "to_date": "2026-05-31"
}' -o results.csv
200 OK

report_datetime,journey_id,journey_name,journey_status,node_id,node_type,df_external_id,purchase_count,purchase_amount
2026-05-02 16:49:41.396762,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,40690
2026-05-09 10:01:05.790648,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,90730
2026-05-11 14:17:06.637286,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,23460
2026-05-11 16:44:44.146596,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,45700
2026-05-12 11:43:38.148500,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,54320
2026-05-13 06:35:08.849697,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,23520
2026-05-17 19:20:48.117039,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,55530
2026-05-18 11:06:27.511948,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,40400
2026-05-21 09:10:11.809824,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,40480
2026-05-21 09:51:45.988206,dfinery,์‹œ๋‚˜๋ฆฌ์˜ค,Active,tmdfinery,TEXT_MESSAGE,external_id,1,15400

ํ—ค๋”

์š”์ฒญ ๋ณธ๋ฌธ

์‘๋‹ต

๋‹จ๊ฑด ์บ ํŽ˜์ธ ์‘๋‹ต ์ƒ์„ธ

์บ ํŽ˜์ธ ์—ฌ์ • ์‘๋‹ต ์ƒ์„ธ

์š”์ฒญ ์˜ˆ์‹œ

์‘๋‹ต ์˜ˆ์‹œ

์„ฑ๊ณต ์‘๋‹ต

์‹คํŒจ ์‘๋‹ต

์ƒ์„ธ ์‘๋‹ต
ํ•„์ˆ˜
์ง€์›
์ง€์›
IN_APP_MESSAGE : ์ธ์•ฑ ๋ฉ”์‹œ์ง€,

JOURNEY : ์บ ํŽ˜์ธ ์—ฌ์ •

ํ‘œ์ค€ ์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ
์ปค์Šคํ…€ ์œ ์ € ํ”„๋กœํ•„ ์†์„ฑ
์ฑ„๋„ ์ˆ˜์‹  ๋™์˜ ์†์„ฑ