Skip to Content

์ธ์ฆ

๋ชจ๋“  API ์š”์ฒญ์—๋Š” ์ธ์ฆ์„ ์œ„ํ•œ Bearer ํ† ํฐ (API ํ‚ค)์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

API ํ‚ค ์ƒ์„ฑ

  1. app.ironflock.com์—์„œ IronFlock์— ๋กœ๊ทธ์ธํ•ฉ๋‹ˆ๋‹ค.
  2. User Settings์œผ๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.
  3. API Keys ์„น์…˜์œผ๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.
  4. Create API Key๋ฅผ ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค.
  5. ์ƒ์„ฑ๋œ ํ‚ค๋ฅผ ๋ณต์‚ฌํ•ฉ๋‹ˆ๋‹ค โ€” ํ•œ ๋ฒˆ๋งŒ ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค.

API ํ‚ค ์‚ฌ์šฉ

๋ชจ๋“  ์š”์ฒญ์˜ Authorization ํ—ค๋”์— ํ‚ค๋ฅผ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค:

curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.ironflock.com/v1/ironflock/devices

Python ์˜ˆ์‹œ

import requests API_KEY = "your-api-key" BASE_URL = "https://api.ironflock.com/v1/ironflock" headers = {"Authorization": f"Bearer {API_KEY}"} response = requests.get(f"{BASE_URL}/devices", headers=headers) devices = response.json()

JavaScript ์˜ˆ์‹œ

const API_KEY = "your-api-key"; const BASE_URL = "https://api.ironflock.com/v1/ironflock"; const response = await fetch(`${BASE_URL}/devices`, { headers: { Authorization: `Bearer ${API_KEY}` } }); const devices = await response.json();

์˜ค๋ฅ˜ ์‘๋‹ต

์ƒํƒœ ์ฝ”๋“œ์˜๋ฏธ
401API ํ‚ค๊ฐ€ ์—†๊ฑฐ๋‚˜ ์œ ํšจํ•˜์ง€ ์•Š์Œ
403์ด ์ž‘์—…์— ๋Œ€ํ•œ ๊ถŒํ•œ ๋ถ€์กฑ
404๋ฆฌ์†Œ์Šค๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Œ
422์œ ํšจ์„ฑ ๊ฒ€์‚ฌ ์˜ค๋ฅ˜ (์š”์ฒญ ํŒŒ๋ผ๋ฏธํ„ฐ ํ™•์ธ)
500๋‚ด๋ถ€ ์„œ๋ฒ„ ์˜ค๋ฅ˜

๋ชจ๋“  ์˜ค๋ฅ˜ ์‘๋‹ต์€ JSON ๊ฐ์ฒด๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค:

{ "error": "์˜ค๋ฅ˜ ์„ค๋ช…" }
Last updated on