Skip to main content
ํ™ˆ
์š”๊ธˆ๋ธ”๋กœ๊ทธ์†Œ๊ฐœ๋ฌธ์˜
๋กœ๊ทธ์ธ๋ฌด๋ฃŒ๋กœ ์‹œ์ž‘
DocsAPI ์ฐธ์กฐ

API ์ฐธ์กฐ

๋ชจ๋“  ๊ธฐ๋Šฅ์„ ๊ฐ–์ถ˜ REST API๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ BeeCastly๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ๊ตฌ์ถ•ํ•˜์„ธ์š”. ํ”„๋กœ๊ทธ๋ž˜๋ฐ ๋ฐฉ์‹์œผ๋กœ ์—ฐ๋ฝ์ฒ˜๋ฅผ ๊ด€๋ฆฌํ•˜๊ณ , ๋ฉ”์‹œ์ง€๋ฅผ ๋ณด๋‚ด๊ณ , ์บ ํŽ˜์ธ์„ ๋งŒ๋“ค๊ณ , ์›นํ›„ํฌ๋ฅผ ๊ตฌ์„ฑํ•˜์„ธ์š”.

๊ธฐ๋ณธ URL

https://beecastly.com/api

๋ชจ๋“  API ์—”๋“œํฌ์ธํŠธ๋Š” ์ด ๊ธฐ๋ณธ URL์„ ๊ธฐ์ค€์œผ๋กœ ํ•ฉ๋‹ˆ๋‹ค. ์š”์ฒญ์—๋Š” ์œ ํšจํ•œ API ํ‚ค ๋˜๋Š” JWT ํ† ํฐ์ด ํฌํ•จ๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

๋น ๋ฅธ ์‹œ์ž‘

curl -X GET https://beecastly.com/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

์ž…์ฆ

๋ชจ๋“  ์š”์ฒญ์—๋Š” ๋‹ค์Œ ์ค‘ ํ•˜๋‚˜๋ฅผ ํ†ตํ•œ ์ธ์ฆ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

  • API ํ‚ค - Authorization: Bearer YOUR_API_KEY ํ—ค๋”๋ฅผ ์ „๋‹ฌํ•ฉ๋‹ˆ๋‹ค.
  • JWT ํ† ํฐ โ€” POST /auth/login์—์„œ ํš๋“

๋˜ํ•œ ํ…Œ๋„ŒํŠธ ID๋ฅผ ํฌํ•จํ•˜์„ธ์š”: x-tenant-id: YOUR_TENANT_ID

์ „์ฒด ์ธ์ฆ ๊ฐ€์ด๋“œ ๋ณด๊ธฐ โ†’

API ์—”๋“œํฌ์ธํŠธ

์‘๋‹ต ํ˜•์‹

๋ชจ๋“  ์‘๋‹ต์€ ์ผ๊ด€๋œ JSON ํ˜•์‹์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message description"
}

๋น„์œจ ์ œํ•œ

๋ฌด๋ฃŒ ๋“ฑ๊ธ‰: ์š”์ฒญ 100๊ฐœ/๋ถ„

ํ”„๋กœ ๋“ฑ๊ธ‰: ์š”์ฒญ 1,000๊ฐœ/๋ถ„

Enterprise: ์‚ฌ์šฉ์ž ์ •์˜ ํ•œ๋„

๋ชจ๋“  ์‘๋‹ต์—๋Š” ์†๋„ ์ œํ•œ ํ—ค๋”๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค: X-RateLimit-Remaining