這是本文檔舊的修訂版！
大家好是傳奇小子
介紹
- Client的請求應該使用HTTP/1.0以上協議，Server的響應一定為HTTP/1.0
- Client 和 Server,通過 HTTP GET 或 HTTP POST 請求進行交互。
- 需要事務處理，Client發送完整的請求，并且解析服務器端的相應，保證域名更新的成功。
- 如果請求失敗，則需要延時一段時間（推薦1分鐘）進行重試，直到域名更新成功。
- 更新請求的觸發，有兩種方式：
事件驅動，客戶端偵聽系統的IP請求變化事件，一旦改變了IP，立即發起更新請求，推薦這種方式，更新沒有延時。
定時更新，每隔一定時間，發起更新請求，注意兩次間隔時間不能短于1分鐘（收費用戶不能短于15秒），如果連續3次以上頻繁請求，該域名會被系統自動封堵，返回 abuse 代碼。
- IP的變化檢測，可以采用 web 方式進行檢測，客戶端可以訪問 http://ip.3322.net 獲取自己的IP，兩次請求返回的IP變化了，就發起更新請求。注意訪問 http://ip.3322.net 的兩次間隔時間不能短于1分鐘，如果連續3次以上頻繁請求，該IP會被系統自動封堵
- 使用HTTP驗證作為API的用戶身份驗證方式。
- User-Agent, 代表客戶端名稱、版本，需要根據設備類型、名稱、特征進行自定義，不要使用示范中的名稱，否則可能被封堵
動態域名更新接口
接口地址
API URL
http://members.3322.net/dyndns/update
HTTP請求
GET /dyndns/update?hostname=yourhost.ourdomain.ext&myip=ipaddress&wildcard=OFF&mx=mail.exchanger.ext&backmx=NO&offline=NO HTTP/1.1 Host: members.3322.net Authorization: Basic username:password User-Agent: myclient/1.0 me@null.net
參數說明
- username:password
該參數必選, 用戶名和密碼用來進行身份認證，必須使用 base64進行編碼
- hostname=host.3322.org
該參數必選, 需要更新的域名
- myip=ipaddr
該參數可選, 域名對應的IP。如果不指定，則服務器將選擇最佳的IP(一些Proxy會傳遞客戶端的IP, 這會被服務器檢測到)。如果傳遞的地址格式錯誤，則忽略這個參數，而用服務器檢測 到的IP。
- wildcard=ON|OFF
該參數可選, 該參數可選，是否支持泛域名(通配符)，缺省為OFF。ON意為著 *.host.3322.org等同于host.3322.org
- mx=mailexchanger
該參數可選, 指明Mail eXchanger。必須能夠解析到一個IP，否則被忽略。如果不提供該參數或者 不能解析到一個IP，mx記錄會被刪除。
- backmx=YES|NO
該參數可選, 指明前面的mx參數會被設置成備份郵件服務器，即郵件會首先發送到你的機器上，如果 不成功，才會發送到備份郵件服務器上。
- offline=YES|NO Optional: Yes
該參數可選, 使域名暫時失效。
返回值
更新成功
- good
成功，IP地址已經成功更新，good 后面會跟著所更新的IP地址
- nochg
成功，IP地址和上次請求沒有變化, nochg 后面會跟著所請求的IP地址
更新出錯
- badauth
身份認證出錯，請檢查用戶名和密碼, 或者編碼方式出錯。
- badsys
該域名不是動態域名，可能是其他類型的域名（智能域名、靜態域名、域名轉向、子域名）。
- badagent
由于發送大量垃圾數據，客戶端名稱被系統封殺。
參數出錯
- notfqdn
沒有提供域名參數，必須提供一個在小辣椒注冊的動態域名域名。
- nohost
域名不存在，請檢查域名是否填寫正確。
- !donator
必須是收費用戶，才能使用 offline 離線功能。
- !yours
該域名存在，但是不是該用戶所有。
- !active
該域名被系統關閉，請聯系小辣椒客服人員。
- abuse
該域名由于段時間大量發送更新請求，被系統禁止，請聯系小辣椒客服人員。
- dnserr
DNS 服務器更新失敗
獲取IP接口
客戶端可以通過該接口獲取自己的IP，用于客戶端檢測IP的變化。
注意訪問 http://ip.3322.net 的兩次間隔時間不能短于1分鐘，如果連續3次以上頻繁請求，該IP會被系統自動封堵
接口地址
API URL
http://ip.3322.net
參數說明
無
返回值
客戶端的IP地址
常見問題
- 沒有對請求做事務處理，沒有檢查服務器的返回值，沒有判斷域名更新是否成功
- 更新失敗以后，沒有記錄日志，沒有進行延時、重試的過程
- 請求過于頻繁，導致域名被服務器封殺
- 客戶端使用實例的名字，沒有根據自己設備的類型、名稱、特征進行自定義
設備認證
小辣椒動態域名更新API簡單易用，方便了開發者和集成商開發自己的客戶端，給設備增加動態域名功能。
但是如果對客戶端的理解不深入，會產生一些錯誤或者更新失敗，導致動態域名更新失敗，用戶無法通過域名訪問設備。
小辣椒為了規范域名的更新流程，保障設備的正常工作，對市場上使用小辣椒動態域名更新API的設備進行認證：
- 由小辣椒的工程師，對設備進行認真，全面的測試，保證設備能夠在各種網絡條件、各種異常條件下正常更新域名
- 提供認證的設備清單，推薦小辣椒的廣大用戶選用
設備認證的具體方法，請參見設備認證
