ํ‘œ API ์‚ฌ์šฉ ๋ฐฉ๋ฒ•

Prev Next

Tulip API๋ฅผ ์„ค์ •ํ•˜๊ณ  ์‚ฌ์šฉํ•˜์—ฌ ๋‹ค๋ฅธ ์‹œ์Šคํ…œ์—์„œ Tulip๊ณผ ์ƒํ˜ธ ์ž‘์šฉํ•˜์„ธ์š”.

{{์Šค๋‹ˆํŽซ.API ๋ฌธ์„œ ๋งํฌ}}

Advanced Content

This article assumes previous experience with APIs.

Tulip์€ ์ปค๋„ฅํ„ฐ๋ฅผ ํ†ตํ•ด ๋‹ค๋ฅธ ๋งŽ์€ ์‹œ์Šคํ…œ์˜ API์™€ ์ƒํ˜ธ ์ž‘์šฉํ•ฉ๋‹ˆ๋‹ค. ์ปค๋„ฅํ„ฐ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Tulip ์•ฑ์€ HTTP ๋˜๋Š” SQL ์ฟผ๋ฆฌ๋ฅผ ์‹œ์ž‘ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋‹ค๋ฅธ ๊ฒฝ์šฐ์—๋Š” ์™ธ๋ถ€ ์‹œ์Šคํ…œ์ด Tulip ๋‚ด์—๋งŒ ์กด์žฌํ•˜๋Š” ๋ฐ์ดํ„ฐ๋ฅผ ์ฟผ๋ฆฌํ•˜๋„๋ก ํ—ˆ์šฉํ•˜๊ณ  ์‹ถ์„ ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค. Tulip API๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด ์™ธ๋ถ€ ์‹œ์Šคํ…œ์—์„œ Tulip๊ณผ ํ†ต์‹ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ๋ฌธ์„œ์—์„œ๋Š” Tulip API ์„ค์ • ๋ฐ ํ…Œ์ŠคํŠธ์— ๋Œ€ํ•ด ์„ค๋ช…ํ•ฉ๋‹ˆ๋‹ค.

Tulip API๋Š” Tulip ํ…Œ์ด๋ธ”์„ ํ†ตํ•ด ์ด๋Ÿฌํ•œ ์™ธ๋ถ€ ์‹œ์Šคํ…œ์„ Tulip๊ณผ ํ†ตํ•ฉํ•˜๋Š” ๋ฐ ์œ ์šฉํ•ฉ๋‹ˆ๋‹ค. ์—ฌ๊ธฐ์—๋Š” ์ƒˆ ์ •๋ณด๋กœ ํ…Œ์ด๋ธ” ๋ ˆ์ฝ”๋“œ๋ฅผ ์—…๋ฐ์ดํŠธํ•˜๊ฑฐ๋‚˜, ํ…Œ์ด๋ธ”์„ ๋งŒ๋“ค๊ฑฐ๋‚˜, ํ…Œ์ด๋ธ”์˜ ๋ ˆ์ฝ”๋“œ ์ˆ˜๋ฅผ ๊ฐ€์ ธ์˜ค๋Š” ์ž‘์—…์ด ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์˜ˆ์ œ

๋‹ค์Œ ์˜ˆ์ œ์—์„œ๋Š” Tulip API์— ์š”์ฒญํ•˜๋Š” ํ”„๋กœ์„ธ์Šค๋ฅผ ์•ˆ๋‚ดํ•ฉ๋‹ˆ๋‹ค. ์ด ์˜ˆ์—์„œ๋Š” Postman์„ ์‚ฌ์šฉํ•˜์—ฌ Tulip์— ์š”์ฒญํ•ฉ๋‹ˆ๋‹ค.

ํ…Œ์ด๋ธ” ์ด๋ฆ„ ๋ฐ ์ •๋ณด ๊ฐ€์ ธ์˜ค๊ธฐ

์ด GET ์š”์ฒญ์€ ์™ธ๋ถ€ ์‹œ์Šคํ…œ์—์„œ Tulip ์ธ์Šคํ„ด์Šค ๋‚ด์˜ ๋ชจ๋“  ํ…Œ์ด๋ธ”์˜ ID์™€ ์—ด ์ •๋ณด๋ฅผ ๊ฒ€์ƒ‰ํ•  ์ˆ˜ ์žˆ๊ฒŒ ํ•ด์ค๋‹ˆ๋‹ค. ์ด๋Š” POST ์š”์ฒญ์„ ์„ค์ •ํ•˜๊ธฐ ์œ„ํ•ด ๊ด€์‹ฌ ์žˆ๋Š” ํ…Œ์ด๋ธ”์„ ์ฐพ๋Š” ๋ฐฉ๋ฒ•์œผ๋กœ ์œ ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Postman์—์„œ ๊ถŒํ•œ์„ ๊ธฐ๋ณธ ์ธ์ฆ์œผ๋กœ ์„ค์ •ํ•˜๊ณ  API ํ‚ค์™€ ๋น„๋ฐ€๋ฒˆํ˜ธ๋ฅผ ์ž…๋ ฅํ•ฉ๋‹ˆ๋‹ค.

์ด์ œ ์š”์ฒญ์ด ์˜ฌ๋ฐ”๋ฅธ ์œ„์น˜๋กœ ์ด๋™ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. Tulip์—์„œ API ๋ฌธ์„œ์—์„œ ์›ํ•˜๋Š” ์š”์ฒญ์„ ์ฐพ์Šต๋‹ˆ๋‹ค. ์ด ๊ฒฝ์šฐ ์š”์ฒญ์€ ๋ชจ๋“  ํ…Œ์ด๋ธ” ์ •๋ณด๋ฅผ ๊ฐ€์ ธ์˜ค๋Š” ๊ฒƒ์ž…๋‹ˆ๋‹ค.

์š”์ฒญ URL์„ ๊ฐ€์ ธ์˜ค๋ ค๋ฉด ์‹คํ–‰ ๋ฒ„ํŠผ์„ ์‹คํ–‰ํ•˜๊ณ  ์š”์ฒญ ์ •๋ณด๋ฅผ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.

๊ทธ๋Ÿฌ๋ฉด ์ด ์š”์ฒญ URL์„ ์„œ๋ฒ„ URL๋กœ ์‚ฌ์šฉํ•˜์—ฌ Postman์˜ GET ์š”์ฒญ์„ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋ณด๋‚ด๊ธฐ๋ฅผ ํด๋ฆญํ•˜๋ฉด ์š”์ฒญ์ด ํ…Œ์ด๋ธ”์˜ ๋ชจ๋“  ์ •๋ณด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค.

ํ…Œ์ด๋ธ” ๋ ˆ์ฝ”๋“œ ๋งŒ๋“ค๊ธฐ

POST์™€ ์œ„์—์„œ ์ฐพ์€ ํ…Œ์ด๋ธ” ID๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์™ธ๋ถ€ ์‹œ์Šคํ…œ์—์„œ ํ…Œ์ด๋ธ” ๋ ˆ์ฝ”๋“œ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ถŒํ•œ ๋ถ€์—ฌ ๋ฐ ํ—ค๋”๋Š” ๋™์ผํ•˜๊ฒŒ ์œ ์ง€๋˜์ง€๋งŒ ์š”์ฒญ URL์€ ์•ฝ๊ฐ„ ๋‹ฌ๋ผ์ง‘๋‹ˆ๋‹ค.

๋จผ์ € ๋ ˆ์ฝ”๋“œ๋ฅผ ๋งŒ๋“ค๋ ค๋Š” ํ…Œ์ด๋ธ”์„ ๊ฒฐ์ •ํ•ฉ๋‹ˆ๋‹ค. ์š”์ฒญ URL์€ ํ•ญ์ƒ ๋‹ค์Œ ๊ตฌ์กฐ๋ฅผ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค:

NOTE

If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.

https://(๋‹น์‹ ์˜ ์ธ์Šคํ„ด์Šค ์ด๋ฆ„ ์—ฌ๊ธฐ).tulip.co/api/v3/w/(์ž‘์—… ๊ณต๊ฐ„)/tables/(TableID)/records

์ž…๋ ฅ์ด ์™„๋ฃŒ๋˜๋ฉด ์š”์ฒญ์— POST๋ฅผ ์ œ๋Œ€๋กœ ์ฒ˜๋ฆฌํ•˜๊ธฐ ์œ„ํ•œ ๋ณธ๋ฌธ๋„ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค. ์Šคํ‚ค๋งˆ ์—ด์€ ์œ„์˜ ํ…Œ์ŠคํŠธ ์„น์…˜์— ๋‚˜์™€ ์žˆ์œผ๋ฉฐ API ๋ฌธ์„œ์—์„œ ์ฐพ์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ด ์ž‘์—…์ด ์„ฑ๊ณตํ•˜๊ธฐ ์œ„ํ•ด ์™„์ „ํžˆ ํ•„์š”ํ•œ ์œ ์ผํ•œ ์—ด์€ ID ์—ด์ž…๋‹ˆ๋‹ค. ์ถ”๊ฐ€ํ•˜์ง€ ์•Š์€ ๋‹ค๋ฅธ ์—ด์€ ์ƒ์„ฑ ์‹œ ํ…Œ์ด๋ธ” ๋ ˆ์ฝ”๋“œ์— null๋กœ ์ €์žฅ๋ฉ๋‹ˆ๋‹ค. ์ด ์ฝ˜ํ…์ธ ๋ฅผ ์š”์ฒญ์˜ ๋ณธ๋ฌธ์œผ๋กœ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

์ œ์ถœ ์‹œ Postman์€ ๋ ˆ์ฝ”๋“œ๊ฐ€ ์ƒ์„ฑ๋˜์—ˆ๋Š”์ง€ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.


์›ํ•˜๋Š” ์ •๋ณด๋ฅผ ์ฐพ์•˜๋‚˜์š”?

community.tulip.co๋กœ ์ด๋™ํ•˜์—ฌ ์งˆ๋ฌธ์„ ๊ฒŒ์‹œํ•˜๊ฑฐ๋‚˜ ๋‹ค๋ฅธ ์‚ฌ๋žŒ๋“ค์ด ๋น„์Šทํ•œ ๋ฌธ์ œ๋ฅผ ๊ฒช์—ˆ๋Š”์ง€ ํ™•์ธํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค!