バックオフィス業務のお悩みや、PCAの業務ソフトをお使いの皆様の
お悩み解決を提供する総合サイト

Web-API（ウェブ・エーピーアイ）は、インターネットを介してプログラム同士が連携するための仕組みで、共通のルール（HTTPなどのWeb技術）に従ってプログラム間でデータや機能をやり取りする窓口です。
当記事では、PCAクラウドWeb-APIを利用するうえで欠かせない「HTTP/HTTPS通信」の基本を解説します。
ちなみに、皆さんが使っているEdgeやChromeなどのWebブラウザも、HTTP/HTTPS通信を使ってサーバーからデータを受け取り、その内容（レスポンスボディ）をもとにWebページを表示しています。

実際にPCAクラウドWeb-APIを使う際には、利用するプログラミング言語でHTTP通信のライブラリ（プログラミング部品）が用意されております。当記事では、そのHTTPアクセスのライブラリを理解する助けとして、HTTP通信メッセージの構成要素を解説します.

HTTPとは

HTTP(Hypertext Transfer Protocol)は、WebサーバーとWebブラウザがデータをやり取りするための通信のルール（プロトコル） です。そのルールをプログラム間のデータ連携に応用したのが、「Web-API」です。

HTTPは 「リクエスト」と「レスポンス」 のやり取りによって成り立っています。クライアントがサーバーに「HTTPリクエストメッセージ」を送信し、それに対してサーバーが「HTTPレスポンスメッセージ」を返す、という形で通信が行われます。

（補足）HTTPSとは

HTTPSは、HTTP通信をSSL/TLSという暗号化技術で保護した、安全な通信方式です。HTTPが「はがき」でやり取りする通信だとすれば、HTTPSは「封筒に入れて送る通信」のようなものです。内容が第三者に見られないよう守られています。

HTTPリクエストとレスポンスメッセージ

（PCAクラウドWeb-APIでのリクエストとレスポンスの例）

HTTP メッセージは、スタートライン、ヘッダー、ボディで構成されていて、クライアントからサーバーへのリクエスト（要求）である「リクエストメッセージ」、サーバーからクライアントへのレスポンス（応答）である「レスポンスメッセージ」の 2 種類があります。
リクエスト、レスポンスそれぞれのメッセージの構成要素は、以下の表の通りです。

HTTPリクエストメッセージ

 

HTTPレスポンスメッセージ

HTTPメソッドとリクエストボディの関係

（リクエストボディとは、リクエストメッセージのボディを指します。ヘッダー、ボディが両メッセージに存在するため、このような呼び方をします。）

HTTP では、HTTPメソッドが定義されています。
PCAクラウドWeb-APIでは、「GET」と「POST」の二つのHTTPメソッドを使用します。

「GET」メソッドでは通常リクエストボディを使用せず、送信したいデータをクエリパラメータとしてURIの末尾に付加します。
例えば「?Id=1&Code=0001」のように、パラメータ名と値をセットに指定します。

一方、「POST」メソッドでは送信したいデータをContent-Typeで指定したメディタイプの形式でリクエストボディに設定します。
このため「GET」メソッドに比べてより大きなデータを送信できるほか、Webブラウザのアドレスバーにパラメータの内容が表示されないという特徴があります。

HTTPステータスコードとメッセージ

Web-APIでは、リクエストに対する処理結果を先ずHTTPステータスコードで返します。
ステータスコードは、通信や処理が正常に完了したか、またはエラーが発生したかを示す番号です。

PCAクラウドWeb-APIから返す主なHTTPステータスコードは、次の表の通りです。

ステータスメッセージは、各ステータスコードに対応してHTTPの規格で定められた標準メッセージ が表示されます。
たとえば、ステータスコード「200」には「OK」、「404」には「Not Found」などのメッセージが設定されています。
そのため、PCAクラウドWeb-APIではステータスコードが 200（OK）以外 の場合、レスポンスボディ内に Code や Message などの エラー情報 が含まれます。
これらステータスコードやエラー情報の内容を確認することで、エラーの原因を特定できます。