接上客戶系統
API 是一扇門
客戶說「我們有 API」時,你聽到的不該是檔案交換,而是一扇有規則的門:誰能敲、敲的時候要帶什麼、門裡會遞出什麼。
先讀這四行
這扇門回答哪個問題?要帶的識別是什麼?成功時回來哪些欄位?不成功時怎麼表示?四行讀完,你就知道它配不配得上範圍單。訂單查詢若回答不了「下單日」,它就還不能支撐七日規則。
不要從認證方式開始讀。認證很重要,但你若不知道這扇門回答什麼,會把時間花在打開一扇用不到的門。先對問題,再對鑰匙的種類。
欄位要對上政策
政策說七日,門必須給一個日期,而且你要問清楚是下單日、出貨日還是送達日。政策說品類例外,門必須給品類代碼,而且代碼表要有人負責。缺一個欄位,不是「先做起來」,是範圍要改或門要換。
把欄位寫成對照表:政策句子、需要的欄位、這扇門有沒有、沒有時第一版怎麼退。這張表是你跟資訊窗口的共同語言。
一扇門不夠就說不夠
退貨資格可能要訂單門,也可能要例外清單那份表。兩扇門都沒有之前,不要用模型的常識補。你已經在原型課學過編造。接系統時最常見的編造,是介面沒給的欄位被提示詞補上。
範例 · 訂單查詢的四行
一份夠你判斷的說明,長這樣就夠開始談,不必先背協議。
- 回答的問題:這個訂單編號是否存在,以及下單日、品類代碼、金額、是否出貨。
- 要帶的識別:訂單編號。不接受姓名查詢。
- 成功:回傳上述欄位。查無:明確的空結果,不是錯誤頁。
- 其他不成功:逾時、識別格式不符、呼叫者無權。三種要分得開。
練習
找一份你工作裡看過的介面說明或內部文件,寫出四行。寫不出「回答哪個問題」,就標成還沒讀懂。
把七日退貨政策對上欄位。缺欄位就寫進範圍單的風險,而不是假設上線前會有人補上。
完成的時候
- 你能不看講義,說明 API 和「傳一個檔案」差在哪。
- 你有一張政策句子對欄位的表,並標出缺的欄位。