# Web API について

Web API は、ブラウザーおよびモバイル機器を含む幅広いクライアントに提供される HTTP サービスを構築するためのフレームワークです。

### 基本 URL

以下が基本の URL です。

<Protocol>://<Domain Name>:<Port Number>/api/v1

- プロトコル: HTTP (バージョン 1.1)
- ドメイン名: 表示器の IP アドレスを使用します。

  MEMO: 表示器が SP5000 シリーズオープンボックス (Windows 10 IoT Enterprise モデル)、IPC シリーズ、PC/AT の場合は表示器名も使用できます。

- ポート番号: 画面編集ソフトウェアでポート番号を設定できます。Web サーバー設定の指定

## ログイン

ユーザー名とパスワードを入力してトークンを取得します。セキュリティを使用する場合、認証にトークンが使われます。

MEMO: トークン認証は、サーバー、ネットワーク、またはその他のセキュリティ保護されたシステムにログインしようとするユーザーを、サーバーから与えられるセキュリティトークンを使って認証するセキュリティ手法です。

概要

### リクエスト

項目 | 値
方式 | POST
URL | <Base URL>/login
パラメーター | N/A
ヘッダー | Content-Type、Content-Length
ヘッダー | 値
Content-Type | application/json
ボディ | JSON
フィールド | データの種類 | 備考
username | 文字列 | ユーザー名
password | 文字列 | パスワード
例 | 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" } MEMO: サンプルコードは Java で書かれています。

### レスポンス

項目 | 値
状態コード | 認証に成功すると、表示器は 200 (OK) を送信します。
コード | 備考
200 OK | 認証に成功
401 Unauthorized | 認証に失敗
ヘッダー | Content-Type, Transfer-Encoding
ヘッダー | 値
Content-Type | application/json
Transfer-Encoding | Chunked
ボディ | JSON
フィールド | データの種類 | 備考
token | 文字列 | 認証トークン
例 | 0 MEMO: サンプルコードは Java で書かれています。