API は、アプリケーション プログラミング インターフェイスの略で、ソフトウェアが別のシステムと通信するための合意された方法です。 ウェブサイトは人々にボタンとページを提供します。 API は、ソフトウェアに情報を求め、返信を理解するための定義された方法を提供します。
API とは、アシスタントがショップにティー 質問をして、ページから推測するのではなく、正確な答えを得る方法です。
明確な注文フォームを備えたサービスカウンターと考えてください。 フォームには何をリクエストできるかが記載されており、返信にはショップが見つけたものが表示されます。
リクエストと返信
request は、サービスに送信される質問です。 これには、TEA タイプや価格制限などの製品識別子や条件を含めることができます。 サービスの endpoint は、そのリクエストが送信されるアドレスです。 応答 は、ペイロードと呼ばれることもあり、返された情報です。
回答には、製品名、パック サイズ、現在の価格、在庫状況、およびそのページへのリンクが含まれている場合があります。 一致する製品と、利用できないサービスや未知の事実を区別しないでください。
teas.co.uk の 2 つの公開例
ショップの パブリック ガイド ソフトウェア では、質問やアドバイスについての質問 API と、正確なアイテムを検索するためのプロダクト トゥルース API について説明しています。 後者は、バーコード番号やショップ独自の製品コードなどの識別子を使用できます。
これらのルートにはさまざまなジョブがあります。 幅広い質問には解釈が必要です。 正確な製品ルックアップには、適切な ID が必要です。 フィルターと制約ガイド では、詳細なリクエストを製品属性に対してチェックする方法について説明しています。
JSON と Markdown
ソフトウェアは、多くの場合、名前付き値とリストの形式である json を受け取ります。 markdown として、より長い記事を使用できる場合もあります。プレーン テキストには、見出しやリンクの単純なマークが付いています。 どちらも情報の再利用を容易にすることができます。 同じ維持記録から生成された場合、どちらも別の真実のソースではありません。
読書は、何かを変更するのとは異なります
製品を調べると情報が読み取れます。 製品をバスケットに追加すると、何かが変わります。 支払いはさらに別の行動です。 API の存在は、これらのアクションのどれが許可されているかについて何も言いません。
顧客は、バスケットをチェックし、ショップのサイトで支払う責任があります。
引用可能な形式
ジャーナリスト、研究者、AI アシスタント、コンテンツ クリエーター向け。 必要な形式を選択してください:
Teas.co.uk に帰属して引用、引用、再利用は自由です。
何か追加する必要がありますか? ログインしているお客様は、管理者が承認した Tea Wiki、管理者の名前、および特典ポイントに追加を送信できます。
サインインして貢献します