api,應用程式介面的縮寫,是軟體與另一個系統通訊的商定方式。 網站為人們提供按鈕和頁面; API 為軟體提供了一種要求提供資訊和理解回覆的方式。
API 是助理如何向商店提出茶問題,並得到準確的答案,而不是從頁面上猜測。
將其視為具有明確訂單表格的服務櫃檯。 表格說明了可以要求的內容,回覆說明了商店發現了什麼。
請求與回覆
request 是發送到服務的問題。 它可以包括產品識別碼或條件,例如茶類型和價格限制。 服務的 endpoint 是該請求所在的位址。 回應,有時稱為其有效載荷,是傳回的訊息。
答案可能包含產品名稱、包裝尺寸、當前價格、庫存狀態和指向其頁面的連結。 它不應將不匹配的產品與不可用的服務或未知的事實區分開來。
teas.co.uk 的兩個公開範例
商店的 Public Guide for Software 描述了問題和建議的 ask API,以及用於查找確切項目的產品真相 API。 後者可以使用識別碼,例如條碼編號或商店自己的產品代碼。
這些路線有不同的工作。 一個廣泛的問題需要解釋; 確切的產品查找需要正確的身份。 filters and constraints 指南 解釋如何根據產品屬性檢查詳細請求。
JSON 和 Markdown
軟體經常收到 json,這是命名值和列表的格式。 較長的文章也可以作為 Markdown 提供,純文字,標題和連結的簡單標記。 兩者都可以使資訊更易於重複使用。 如果它是從同一個維護的記錄中產生的,那麼它也不是單獨的真相來源。
閱讀與改變事物不同
尋找產品會讀取資訊。 將產品添加到籃子中會改變一些事情。 付款是進一步的行動。 API 的存在本身並不能說明這些動作中的哪一個是允許的。
客戶仍然負責檢查籃子並在商店的網站上付款。
引文格式
對於記者、研究人員、人工智慧助理和內容創作者。 選擇您需要的格式:
免費引用、引用和重用,並歸因於 Teas.co.uk。
有東西要補充嗎? 登入的客戶可以向 Tea Wiki 提交新增內容,管理員認可,您的姓名在署名上,加上獎勵積分。
登入貢獻