對接第三方 API 提示詞(讀接口文檔 → 封裝客戶端 → 簽名鑑權、重試限流、回調驗籤 → 測試與對帳)

要接入短訊、物流、地圖、支付、開放平台等第三方接口時用:把對方的接口文檔給 AI,它先提煉出鑑權方式、限流規則、錯誤碼和回調機制,再生成封裝良好的客戶端代碼、模擬測試和上線檢查清單,避免文檔裏的細節被漏掉。

NNathaniel bigo··原創首發·AI 輔助撰寫
通用大模型 對話模型通用
你是一名做過大量第三方系統對接的後端工程師。請幫我對接下面這個第三方接口。

- 第三方服務:[服務名稱](例:某物流公司開放平台)
- 我要用到的接口:[接口列表](例:下單、查詢軌跡、取消)
- 接口文檔(相關章節原樣粘貼:鑑權、簽名、請求示例、錯誤碼、回調說明、限流說明):
  [粘貼接口文檔]
- 我方技術棧:[技術棧]
- 調用場景:[調用場景](例:用戶下單後異步創建物流單)

第一步:文檔提煉(先輸出,供我核對)
1. 環境:測試環境與正式環境的地址、憑證是否不同。
2. 鑑權與簽名:簽名算法、參與簽名的字段與拼接順序、編碼方式、時間戳與隨機數的要求;用文檔中的示例數據推演一遍簽名過程(如果文檔提供了示例)。
3. 限流與配額:文檔寫明的調用頻率限制。
4. 錯誤碼:哪些表示請求有誤(不應重試)、哪些表示暫時失敗(可以重試)、哪些需要人工介入。
5. 回調:回調地址的配置方式、驗籤方法、需要返回的應答格式、對方的重試策略(我方需要冪等處理)。
6. 文檔中含糊或互相矛盾的地方,列成問題,便於向對方技術支援確認。

第二步:代碼
1. 封裝獨立的客戶端模組,業務代碼不直接拼接請求;憑證從配置讀取。
2. 簽名與驗簽單獨實現,並用文檔示例寫單元測試驗證。
3. 超時、按錯誤碼區分的重試、限流控制。
4. 每次調用記錄請求標識、耗時、結果碼(日誌中對敏感字段脫敏)。
5. 回調處理:先驗籤,再按業務單號冪等處理,最後按對方要求的格式應答。
6. 用模擬服務編寫測試,覆蓋成功、業務失敗、超時、簽名錯誤、重複回調。

第三步:上線檢查清單(憑證切換、白名單、回調地址、監控告警、對帳方式)。
文檔中沒有說明的細節不要編造,標註「需向對方確認」。

高亮處換成你自己的內容:[服務名稱]、[接口列表]、[粘貼接口文檔]、[技術棧]、[調用場景]

ChatGPT Plus 充值

已被複製 0 次

使用說明

怎麼填變量:[粘貼接口文檔] 至少包括鑑權簽名、錯誤碼和回調三個章節,這是對接中最容易出錯的地方。文檔是網頁或 PDF 時,複製相關章節的文字即可。

常見坑:

  • 簽名算錯是對接中最常見的問題,原因往往是參數排序、空值是否參與簽名、編碼方式等細節。用文檔給的示例數據寫一個單元測試,簽名結果對上了再聯調。
  • 回調沒有驗籤,任何人都可以偽造一個「支付成功」或「已簽收」的通知。
  • 對方會重複發送回調,我方沒有做冪等處理,導致同一個訂單被處理兩次。

追問技巧:聯調遇到報錯時,把請求、響應和對方返回的錯誤碼貼回去,問「對照文檔,問題最可能出在哪個字段」;上線前追問「寫一個每日對帳腳本,比對我方記錄與對方帳單」。

示例輸出

示例,僅供參考(文檔提煉節選)
項目提煉結果
簽名除簽名字段外的所有非空參數按參數名升序排列,用 鍵=值 加 & 拼接,末尾拼接密鑰,計算哈希後轉大寫
時間戳秒級,與伺服器時間相差超過 5 分鐘拒絕
可重試錯誤碼系統繁忙類錯誤碼
不可重試錯誤碼參數錯誤、簽名錯誤、餘額不足
回調應答返回文檔規定的成功字符串,否則對方會按其重試策略重新推送

需向對方確認:

  1. 文檔中「空值不參與簽名」是指空字符串還是未傳的參數?
  2. 回調重試的間隔與最大次數?

同款作品

用這條提示詞做出來的作品;原作者會因此獲得積分

做同款

還沒有同款,來做第一個。

Nathaniel 的更多內容

同主題

同模型

0 條評論

登入 後參與評論

還沒有評論,來搶沙發~