API
Application Programming Interface
ざっくりまとめnora.icon
ソフトウェアやwebサービスと、その外部にある他のプログラムとを繋ぐ仕組み
サービス同士の「連携」はAPIによって実現されている
「APIを叩く」=APIを実行すること
「HTTPメソッド」という規格化された指示(リクエスト)によって、各サービスが提供しているリソースを利用する。
リクエストの種類として以下の4つがある。普段使うのは「GET」と「POST」。
GETメソッド
POSTメソッド
PUTメソッド
DELETEメソッド
APIでデータを取ってきたい時、トークンやIDが必要な場合は「POST」、必要ない場合は「GET」を使うことが多い。
また、Webアプリケーションの自分のデータに変更を加える場合などは「POST」を用いる。
Webアプリケーション・WebサービスのAPIの例
JavaScriptでAPIにリクエストを送るには
要はfetch(url, option)というメソッドを使うということだが、この仕組み自体がAPIの一種。
現在はこの方法が一般的だが、かなり古いブラウザには対応していない可能性がある。
現在はFetch APIに置き換えられているが、古いコードでは使われているのを目にすることがある。
「jQuery.ajax」を使う(旧式)
ajaxとは「asynchronous JavaScript XML(非同期のJavaScriptとXML)」の略。非同期通信を実現する仕組みを指す。
「jQuery」というJavaScriptライブラリを導入することで利用できる。 Dynalist APIを利用する例
code:js
const token = 'hoge'; // secret tokenをここに入れる(うっかり公開しないように注意)
method: 'POST',
body: JSON.stringify({
token: token,
'file_id': fileId,
}),
})
.then(response => response.json())
.then(data => {
console.log(data);
// dataを使って任意の処理
})