๐Ÿ“ฆ Delivery Tracker

API Documentation

๋ฐฐ์†ก ์ถ”์  SaaS API ์™„๋ฒฝ ๊ฐ€์ด๋“œ

๋น ๋ฅธ ์‹œ์ž‘

1. Base URL

https://deliverytracking.compatibleai.co.kr

2. ์ธ์ฆ (์„ ํƒ์‚ฌํ•ญ)

๐Ÿ“Œ ์ฐธ๊ณ : ๊ธฐ๋ณธ ํŠธ๋ž˜ํ‚น API๋Š” ์ธ์ฆ ์—†์ด ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค. ์ธ์ฆ์€ ๊ณ ๊ธ‰ ๊ธฐ๋Šฅ (API ํ‚ค ๊ด€๋ฆฌ, ์›นํ›…, ๋ถ„์„ ๋“ฑ)์—๋งŒ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

# ์ธ์ฆ์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ์—๋งŒ ์‚ฌ์šฉ:
Authorization: Bearer YOUR_ACCESS_TOKEN
# ๋˜๋Š”
X-API-Key: YOUR_API_KEY

3. ์ฒซ ๋ฒˆ์งธ ์š”์ฒญ ์˜ˆ์‹œ

curl -X GET "https://deliverytracking.compatibleai.co.kr/api/v1/carriers" \
  -H "Accept: application/json"

Rate Limiting

API๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์€ ์†๋„ ์ œํ•œ์ด ์ ์šฉ๋ฉ๋‹ˆ๋‹ค:

  • โ€ข ๊ธฐ๋ณธ: ๋ถ„๋‹น 60๊ฐœ ์š”์ฒญ
  • โ€ข Pro ํ”Œ๋žœ: ๋ถ„๋‹น 300๊ฐœ ์š”์ฒญ
  • โ€ข Enterprise: ๋ฌด์ œํ•œ

์ œํ•œ ์ดˆ๊ณผ ์‹œ 429 Too Many Requests ์‘๋‹ต์„ ๋ฐ›๊ฒŒ ๋ฉ๋‹ˆ๋‹ค.

Error Codes

Status CodeDescription
200์„ฑ๊ณต
400์ž˜๋ชป๋œ ์š”์ฒญ
401์ธ์ฆ ์‹คํŒจ
403๊ถŒํ•œ ์—†์Œ
404๋ฆฌ์†Œ์Šค๋ฅผ ์ฐพ์„ ์ˆ˜ ์—†์Œ
429์š”์ฒญ ํšŸ์ˆ˜ ์ดˆ๊ณผ
500์„œ๋ฒ„ ๋‚ด๋ถ€ ์˜ค๋ฅ˜

SDK & Libraries

๋‹ค์–‘ํ•œ ํ”„๋กœ๊ทธ๋ž˜๋ฐ ์–ธ์–ด๋กœ ์‰ฝ๊ฒŒ ํ†ตํ•ฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:

JavaScript

npm i @delivery/sdk

Python

pip install delivery-sdk

Java

com.delivery:sdk

Go

go get delivery/sdk