先畫出資料流
先標示資料來源、目的地、同步方向與觸發時機。沒有資料流圖就開始寫 API,容易產生重複寫入或責任不清。
- 哪個系統是主資料來源?
- 同步是即時、排程還是人工觸發?
- 資料寫入失敗時誰收到通知?
- 哪些欄位需要保留原始值?
API 金鑰與版本要被管理
Ragic 官方 API 文件建議使用 HTTPS,並提醒 API 金鑰具備權限。正式整合時應使用專用帳號、保護秘密資訊,並明確指定 API 版本。
文件是交付的一部分
除了程式本身,也要留下端點、欄位對照、請求範例、錯誤回應與維護方式。這些資料會直接影響後續交接。