https://github.com/magiclen/tw-nhi-icc-service
Read Taiwan NHI cards via HTTP API. 透過 HTTP API 讀取中華民國健保卡。
https://github.com/magiclen/tw-nhi-icc-service
pcsc rust smart-card taiwan tw-nhi-icc
Last synced: 6 months ago
JSON representation
Read Taiwan NHI cards via HTTP API. 透過 HTTP API 讀取中華民國健保卡。
- Host: GitHub
- URL: https://github.com/magiclen/tw-nhi-icc-service
- Owner: magiclen
- License: mit
- Created: 2023-02-05T14:41:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T03:23:23.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T17:55:20.783Z (7 months ago)
- Topics: pcsc, rust, smart-card, taiwan, tw-nhi-icc
- Language: Rust
- Homepage:
- Size: 56.6 KB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TW NHI IC Card Service
===============
[](https://github.com/magiclen/tw-nhi-icc-service/actions/workflows/ci.yml)
透過 HTTP API 讀取中華民國健保卡。
Read Taiwan NHI cards via HTTP API.
## 用法
#### 執行環境
###### Windows / macOS
請先安裝好您讀卡機的驅動程式。
###### Linux
需有 `pcscd` (來自 [PCSClite project](https://pcsclite.apdu.fr/))。
基於 Debian 的 Linux 發行版可用以下指令安裝：
```bash
sudo apt install pcscd
sudo systemctl enable pcscd
```
接著安裝好您讀卡機的驅動程式。
#### 開發環境
若要在 GNU/Linux 下編譯本專案，需要 `libpcsclite-dev` 套件。
基於 Debian 的 Linux 發行版可用以下指令安裝：
```bash
sudo apt install libpcsclite-dev
```
#### 命令列介面 (CLI)
```text
EXAMPLES:
tw-nhi-icc-service # 啟動 HTTP 服務，監聽 127.0.0.1:58113
tw-nhi-icc-service -i 0.0.0.0 -p 12345 # 啟動 HTTP 服務，監聽 0.0.0.0:12345
Usage: tw-nhi-icc-service [OPTIONS]
Options:
-i, --interface 要監聽的網路介面 IP [default: 127.0.0.1] [aliases: ip]
-p, --port 要監聽的連接埠 [default: 8000]
--default-ws-card-fetch-interval WebSocket 回傳卡片資料的預設時間間隔（秒） [default: 3000] [aliases: interval]
-h, --help Print help
-V, --version Print version
```
#### HTTP API
啟動 HTTP 服務後，可以存取以下的端點：
* `GET /`：讀取所有讀卡機的健保卡中的基本資料。回應的 Content-Type 為 `application/json`。JSON 格式如下：
```json
[
{
"reader_name": "讀卡機名稱",
"card_no": "卡號",
"full_name": "全名",
"id_no": "身份證字號",
"birth_date": "0000-00-00",
"birth_date_timestamp": 0,
"sex": "M：男；F：女",
"issue_date": "0000-00-00",
"issue_date_timestamp": 0
},
...
]
```
* 時間戳記(timestamp)的單位是毫秒，會使用本地的時區，建議將時區設定為 `GMT+8`。
* `GET /version`：回傳此服務的版本，可用來檢驗此服務是否正常在監聽。回應的 Content-Type 為 `application/json`。JSON 格式如下：
```json
{
"major": 0,
"minor": 1,
"patch": 5,
"pre": "",
"text": "0.1.5"
}
```
* `GET /ws`：**WebSocket 端點**。查詢中可以代入 `interval` 欄位來設定伺服器回傳所有讀卡機的健保卡中的基本資料的時間間隔，單位為秒。回傳的資料格式請見 `GET /`。客戶端也可以在連線時傳送要使用的時間間隔秒數來更改回傳設定。
## 客戶端函式庫
* [`tw-nhi-icc`](https://github.com/magiclen/tw-nhi-icc)：在 JavaScript/TypeScript 中，讀取中華民國健保卡。
## License
[MIT](LICENSE)