APIとはどういう意味ですか?

API は Application Programming Interface の略で、アプリケーションが指定されたデータにアクセスし、外部のソフトウェア アプリケーション コンポーネント、オペレーティング システム、またはマイクロサービスと対話できるようにする一連の関数コードを意味します。

単純化すると、API はユーザーの応答をシステムに送信し、システムの応答をユーザーに送り返します。 「カートに追加」をクリックします。 API は、カートに製品を追加したことをサイトに伝えます。 Web サイトで商品がカートに入れられ、カートが更新されます。

API に関連して「マイクロサービス」という用語が登場するかもしれません。ただし、これらは同じではありません。マイクロサービスは、Web アプリケーション内の機能を分割するスタイルまたはアーキテクチャです。一方、API は開発者が Web アプリケーションと対話するためのフレームワークです。マイクロサービスは実際に次のことが可能です APIを使って通信する お互いの間に。

API を使用すると、開発者は情報を送受信するために特定の「呼び出し」または「リクエスト」を行うことができます。この通信は「JSON」と呼ばれるプログラミング言語を使用して行われます。データの更新や削除などの定義されたアクションを実行するために使用することもできます。 API を使用して作成できる基本的なリクエスト メソッドは 4 つあります。

GET – 情報を収集します（すべてのクーポンコードを取得します）

PUT – データの一部を更新します (製品価格の更新)

POST – 作成 (新しい製品カテゴリの作成)

DELETE – (ブログ投稿の削除)

JSON とは何ですか?なぜ使用されるのですか?

JSON (JavaScript Object Notation) は、サーバー上のデータを表すために使用されます。人間にとっては非常に読みやすく、機械やアプリケーションにとっても理解しやすいものです。 BigCommerce 上の商品の JSON の例を見てみましょう。

これは、キーと値のペアで出力され、左側にキー、右側に値が表示されるため、理解しやすいです。キーはアプリケーションによって定義される固定オブジェクトであり、「カテゴリ」と同じままになります。一方、値は「シャツ」などの一意になります。

APIリクエストとは何ですか?

API リクエストが機能するためには、API リクエストのコンポーネントがいくつかあります。これらを個別に説明し、それらを使用してリクエストを作成する方法を見てみましょう。

エンドポイントとは

API リクエストを行うときに使用されるエンドポイントには 404 つの重要な部分があります。その XNUMX つは URL です。 BigCommerce は、すべての API リクエストの URL として https://api.bigcommerce.com/stores/ を使用します。これは通常の URL のように見えますが、これを Web ブラウザに接続すると、XNUMX エラー メッセージが表示されます。

3 番目の部分はパスです。その道は、何を達成しようとしているかによって異なります。 BigCommerce で利用可能なパスのリストは、開発者ドキュメント https://developer.bigcommerce.com/api-reference にアクセスして確認できます。この例では、製品パス /vXNUMX/catalog/products を使用します。

これら 3 つの部分を組み合わせると、完全なエンドポイント https://api.bigcommerce.com/stores/{store_hash}/vXNUMX/catalog/products が得られます。 「{store_hash} とは何ですか?」「それはどこから来たのですか?」と思っているかもしれません。これは変数として知られているものです。変数はエンドポイントに固有のコンポーネントであり、ストアの情報によって異なります。変数は、左括弧と閉じ括弧「{ }」で見つけることができます。

ヘッダーとは何ですか?

ヘッダーはクライアントとサーバーに情報を提供します。ヘッダーの一般的な例は、「認証トークン」や「クライアント ID」などの認証資格情報です。これらの認証情報は、API アカウントを作成するときに自動的に提供されます。もう 1 つの一般的なヘッダーは「コンテンツ タイプ」と呼ばれ、送信されるコンテンツの種類をサーバーに通知します。たとえば、一般的に使用されるコンテンツ タイプは「application/json」です。これにより、JSON データを送信していることがサーバーに認識されます。

メソッドとは？

メソッドは、リクエストの送信時に実行されるアクションです。 GET、PUT、POST、DELETE について説明したときの最初のことを思い出してください。これらはすべて API メソッドです。

データとは何ですか？

リクエスト データは一般に「本文」とも呼ばれ、サーバーに送信されるかサーバーから返される情報です。 JSON に関する前述の説明で、API データの例を確認できます。リクエストの本文は、配信する前に特定の情報を必要とする場合があります。たとえば、単一の製品を編集している場合、変更を加える前に製品 ID が必要になります。

続きを読む こちら.