APIは何の略ですか?平易な英語でのコーディングの頭字語の定義。

いいえ、APIはApple PieInsideの略ではありません。?? APIはApplicationProgrammingInterfaceの略です。APIを使用すると、2つのアプリケーションが相互にインターフェース(または相互作用)できます。

APIWebサイトまたはWebベースのソフトウェアアプリケーションにアクセスするために使用されるプログラミング命令と関数のセット。APIを使用すると、他の開発者がアプリケーションのデータと機能を使用できます。それはあなたの製品が他の製品と相互作用することを可能にします。

APIは、1980年代にソフトウェアとハ​​ードウェアの開発で最初に使用されました。しかし今、人々がAPIについて話すとき、彼らは通常Web API、より具体的にはRESTfulAPIを指します。Webベースのアプリケーションを開発するときにRESTfulAPIを使用することが一般的になっています。

Web APIは基本的に、URLを介して完全に対話するプログラムです。通常、ブラウザを使用してURLにリクエストを送信すると、サーバーから応答が返され、表示されます。APIのURLにリクエストを送信する場合は状況が異なります。サーバーは、コンピューターにのみ役立つことを意図したものを送り返します。APIは、別のWebサイトまたはプログラムで使用できるデータを返します。

APIは何に使用されますか?

APIは、エンドユーザーが使用するためのものではありません。これらは、ソフトウェアが他のソフトウェアと対話するために使用されます。たとえば、WebサイトはOpen Weather APIを呼び出して、Webサイトに表示する気象情報を取得できます。

APIは、単一の企業内で使用されることもあります。これらを使用して、相互に簡単に相互作用する内部Webサイトおよびシステムを作成できます。

APIはどのように機能しますか?

APIは通常、他の人に大量の整理されたデータへのアクセスを提供します。そのデータのゲートキーパーは、サーバーに情報を要求するための許可を開発者に(APIキーの形式で)与えます。リクエストが成功すると、サーバーは通常JSONまたはXML形式のメッセージで応答します。

通常、API仕様と呼ばれる使用するAPIのドキュメントがあります。これは、コントロールとAPIの使用方法を説明しています。

特定の場所の現在の天気を取得できるOpenWeatherAPIのAPI仕様の例を次に示します。//openweathermap.org/current

API仕様には、データの取得に使用できるURLのリストが含まれています。URLの1つを使用することは、APIリクエストまたはAPI呼び出しと呼ばれます。多くの場合、仕様には、APIの一部である各URLのパラメーター応答が表示されます

パラメーター

パラメータは、APIが返す情報を指定するためにURLの末尾に追加するものです。パラメータは基本的に、APIに渡す変数です。

OpenWeatherAPIから気象情報を取得するためのURLは次のとおりです。

api.openweathermap.org/data/2.5/weather

ただし、気象データを返す場所を指定するパラメータとして都市を追加する必要があります。これは、cityパラメーターを含むURLです。

api.openweathermap.org/data/2.5/weather?q=London

応答を取得するためにパラメータが必要になる場合があります。パラメータがオプションの場合もあります。OpenWeather APIでは、場所を指定する必要がありますが、都市名以外に場所を指定する方法は他にもあります。すべての方法はAPI仕様に記載されています。

パラメータは次のようなものも指定できます。

  • 結果はどのようにソートする必要がありますか?
  • いくつの結果を返す必要がありますか?
  • 結果はどのような形式にする必要がありますか?
  • どの日付範囲の結果が必要ですか?

応答

APIにリクエストを送信すると、レスポンスが返されます。リクエストしたデータまたはリクエストが失敗した理由のいずれかが返されます。

以下は、次のリクエストを送信したときに得られる応答の例ですapi.openweathermap.org/data/2.5/weather?q=London。JSON応答です。

{ "coord": { "lon": -0.13, "lat": 51.51 }, "weather": [ { "id": 300, "main": "Drizzle", "description": "light intensity drizzle", "icon": "09d" } ], "base": "stations", "main": { "temp": 280.32, "pressure": 1012, "humidity": 81, "temp_min": 279.15, "temp_max": 281.15 }, "visibility": 10000, "wind": { "speed": 4.1, "deg": 80 }, "clouds": { "all": 90 }, "dt": 1485789600, "sys": { "type": 1, "id": 5091, "message": 0.0103, "country": "GB", "sunrise": 1485762037, "sunset": 1485794875 }, "id": 2643743, "name": "London", "cod": 200 }

API応答は、この例のようにフォーマットされていない可能性があります。多くの場合、すべてのテキストが1行になっています。これは主に人ではなくコンピュータによって読み取られることを目的としているため、フォーマットは重要ではありません。

APIキー

上記のURLを自分で試してみると、上記の応答は得られません。おそらく次のようになります。

{ "cod": 401, "message": "Invalid API key. Please see //openweathermap.org/faq#error401 for more info." }

ほとんどのAPIは、データを返す前に何らかの認証を必要とします。これは通常、APIキーの形式です。これらのキーは、パスワードのようなものです。これらは、APIリクエストで送信する必要のある文字と数字の長い文字列であるため、サーバーは情報へのアクセスが許可されていることを認識します。

For the OpenWeather API, and with many other APIs, you can get an API key for free after creating an account. Many companies use API keys on free APIs to make sure people don't make to many requests in one day. It could really bog down a server if a single person made thousands of requests every minute.

Some APIs are public without an API key. Below is an API that allows you to find rhyming words. Click the link, then try changing the final word in the URL to search for different rhyming words.

//api.datamuse.com/words?rel_rhy=camp

Want to learn more?

If you want to learn more about using APIs, check out the video below on the freeCodeCamp.org YouTube channel.