Web API は、ブラウザーおよびモバイル機器を含む幅広いクライアントに提供される HTTP サービスを構築するためのフレームワークです。
以下が基本の URL です。
<Protocol>://<Domain Name>:<Port Number>/api/v1
表示器が SP5000 シリーズオープンボックス (Windows 10 IoT Enterprise モデル)、IPC シリーズ、PC/AT の場合は表示器名も使用できます。
ユーザー名とパスワードを入力してトークンを取得します。セキュリティを使用する場合、認証にトークンが使われます。
トークン認証は、サーバー、ネットワーク、またはその他のセキュリティ保護されたシステムにログインしようとするユーザーを、サーバーから与えられるセキュリティトークンを使って認証するセキュリティ手法です。
| 項目 | 値 | |||||||||
| 方式 | POST | |||||||||
| URL | <Base URL>/login | |||||||||
| パラメーター | N/A | |||||||||
| ヘッダー | Content-Type、Content-Length
|
|||||||||
| ボディ | JSON
|
|||||||||
| 例 | POST http://192.168.1.100:8000/api/v1/login HTTP/1.1 Host: localhost:8082 Content-Type: application/json content-length: 44 { "username":"User1", "password":"Pass1" } サンプルコードは Java で書かれています。 |
| 項目 | 値 | ||||||
| 状態コード | 認証に成功すると、表示器は 200 (OK) を送信します。
|
||||||
| ヘッダー | Content-Type, Transfer-Encoding
|
||||||
| ボディ | JSON
|
||||||
| 例 |
0 サンプルコードは Java で書かれています。 |