{"id":21586098,"url":"https://github.com/magiclen/tw-nhi-icc-service","last_synced_at":"2025-04-10T20:20:23.156Z","repository":{"id":65704325,"uuid":"597752756","full_name":"magiclen/tw-nhi-icc-service","owner":"magiclen","description":"Read Taiwan NHI cards via HTTP API. 透過 HTTP API 讀取中華民國健保卡。","archived":false,"fork":false,"pushed_at":"2023-11-30T03:23:23.000Z","size":58,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T17:55:20.783Z","etag":null,"topics":["pcsc","rust","smart-card","taiwan","tw-nhi-icc"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magiclen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-05T14:41:00.000Z","updated_at":"2024-12-02T14:17:19.000Z","dependencies_parsed_at":"2023-11-15T03:30:15.349Z","dependency_job_id":"cfe6378a-e89d-437a-b912-7dde76b2670a","html_url":"https://github.com/magiclen/tw-nhi-icc-service","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magiclen%2Ftw-nhi-icc-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magiclen%2Ftw-nhi-icc-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magiclen%2Ftw-nhi-icc-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magiclen%2Ftw-nhi-icc-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magiclen","download_url":"https://codeload.github.com/magiclen/tw-nhi-icc-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248289805,"owners_count":21078921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pcsc","rust","smart-card","taiwan","tw-nhi-icc"],"created_at":"2024-11-24T15:12:39.926Z","updated_at":"2025-04-10T20:20:23.139Z","avatar_url":"https://github.com/magiclen.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"TW NHI IC Card Service\n===============\n\n[![CI](https://github.com/magiclen/tw-nhi-icc-service/actions/workflows/ci.yml/badge.svg)](https://github.com/magiclen/tw-nhi-icc-service/actions/workflows/ci.yml)\n\n透過 HTTP API 讀取中華民國健保卡。\n\nRead Taiwan NHI cards via HTTP API.\n\n## 用法\n\n#### 執行環境\n\n###### Windows / macOS\n\n請先安裝好您讀卡機的驅動程式。\n\n###### Linux\n\n需有 `pcscd` (來自 [PCSClite project](https://pcsclite.apdu.fr/))。\n\n基於 Debian 的 Linux 發行版可用以下指令安裝：\n\n```bash\nsudo apt install pcscd\nsudo systemctl enable pcscd\n```\n\n接著安裝好您讀卡機的驅動程式。\n\n#### 開發環境\n\n若要在 GNU/Linux 下編譯本專案，需要 `libpcsclite-dev` 套件。\n\n基於 Debian 的 Linux 發行版可用以下指令安裝：\n\n```bash\nsudo apt install libpcsclite-dev\n```\n\n#### 命令列介面 (CLI)\n\n```text\nEXAMPLES:\ntw-nhi-icc-service                       # 啟動 HTTP 服務，監聽 127.0.0.1:58113\ntw-nhi-icc-service -i 0.0.0.0 -p 12345   # 啟動 HTTP 服務，監聽 0.0.0.0:12345\n\nUsage: tw-nhi-icc-service [OPTIONS]\n\nOptions:\n  -i, --interface \u003cINTERFACE\u003e                           要監聽的網路介面 IP [default: 127.0.0.1] [aliases: ip]\n  -p, --port \u003cPORT\u003e                                     要監聽的連接埠 [default: 8000]\n      --default-ws-card-fetch-interval \u003cMILLI_SECONDS\u003e  WebSocket 回傳卡片資料的預設時間間隔（秒） [default: 3000] [aliases: interval]\n  -h, --help                                            Print help\n  -V, --version                                         Print version\n```\n\n#### HTTP API\n\n啟動 HTTP 服務後，可以存取以下的端點：\n\n* `GET /`：讀取所有讀卡機的健保卡中的基本資料。回應的 Content-Type 為 `application/json`。JSON 格式如下：\n    ```json\n    [\n        {\n            \"reader_name\": \"讀卡機名稱\",\n            \"card_no\": \"卡號\",\n            \"full_name\": \"全名\",\n            \"id_no\": \"身份證字號\",\n            \"birth_date\": \"0000-00-00\",\n            \"birth_date_timestamp\": 0,\n            \"sex\": \"M：男；F：女\",\n            \"issue_date\": \"0000-00-00\",\n            \"issue_date_timestamp\": 0\n        },\n  \n        ...\n    ]\n    ```\n    * 時間戳記(timestamp)的單位是毫秒，會使用本地的時區，建議將時區設定為 `GMT+8`。\n* `GET /version`：回傳此服務的版本，可用來檢驗此服務是否正常在監聽。回應的 Content-Type 為 `application/json`。JSON 格式如下：\n    ```json\n    {\n        \"major\": 0,\n        \"minor\": 1,\n        \"patch\": 5,\n        \"pre\": \"\",\n        \"text\": \"0.1.5\"\n    }\n    ```\n* `GET /ws`：**WebSocket 端點**。查詢中可以代入 `interval` 欄位來設定伺服器回傳所有讀卡機的健保卡中的基本資料的時間間隔，單位為秒。回傳的資料格式請見 `GET /`。客戶端也可以在連線時傳送要使用的時間間隔秒數來更改回傳設定。\n\n## 客戶端函式庫\n\n* [`tw-nhi-icc`](https://github.com/magiclen/tw-nhi-icc)：在 JavaScript/TypeScript 中，讀取中華民國健保卡。\n\n## License\n\n[MIT](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagiclen%2Ftw-nhi-icc-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagiclen%2Ftw-nhi-icc-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagiclen%2Ftw-nhi-icc-service/lists"}