{"id":16729266,"url":"https://github.com/simenkid/node-ecpay-aio","last_synced_at":"2025-06-20T17:37:42.009Z","repository":{"id":65082159,"uuid":"483199848","full_name":"simenkid/node-ecpay-aio","owner":"simenkid","description":"A production-ready ECPay AIO SDK for Node.js","archived":false,"fork":false,"pushed_at":"2022-09-30T00:40:17.000Z","size":461,"stargazers_count":27,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T02:52:38.404Z","etag":null,"topics":["ecpay","ecpay-sdk","javascript","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/simenkid.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}},"created_at":"2022-04-19T10:30:11.000Z","updated_at":"2025-04-16T19:04:57.000Z","dependencies_parsed_at":"2022-12-24T10:19:31.758Z","dependency_job_id":null,"html_url":"https://github.com/simenkid/node-ecpay-aio","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/simenkid/node-ecpay-aio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simenkid%2Fnode-ecpay-aio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simenkid%2Fnode-ecpay-aio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simenkid%2Fnode-ecpay-aio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simenkid%2Fnode-ecpay-aio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simenkid","download_url":"https://codeload.github.com/simenkid/node-ecpay-aio/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simenkid%2Fnode-ecpay-aio/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260988946,"owners_count":23093588,"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":["ecpay","ecpay-sdk","javascript","typescript"],"created_at":"2024-10-12T23:27:54.542Z","updated_at":"2025-06-20T17:37:36.971Z","avatar_url":"https://github.com/simenkid.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-ecpay-aio\n\nA production-ready 綠界全方位金流(ECPay All-In-One, AIO) SDK for Node.js with TypeScript Support\n\n[![build](https://github.com/simenkid/node-ecpay-aio/actions/workflows/build.yml/badge.svg)](https://github.com/simenkid/node-ecpay-aio/actions/workflows/build.yml)\n![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/simenkid/6cd8ec3f4115bc7b0fc0cb646da2dd77/raw/37458fd300efcea7ef2d3adbc4598e47a76a34d9/node-ecpay-aio__heads_main.json)\n[![npm](https://img.shields.io/npm/v/node-ecpay-aio.svg?cacheSeconds=3600)](https://www.npmjs.com/package/node-ecpay-aio)\n[![npm](https://img.shields.io/npm/l/node-ecpay-aio.svg?cacheSeconds=3600)](https://github.com/simenkid/node-ecpay-aio/blob/main/LICENSE)\n[![node version](https://img.shields.io/node/v/node-ecpay-aio)](https://img.shields.io/node/v/node-ecpay-aio)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)\n\n\u003cbr /\u003e\n\n## Documentation\n\n本模組詳細使用說明請見 [User Guide](https://github.com/simenkid/node-ecpay-aio/wiki)\n\n\u003cbr /\u003e\n\n## Overview\n\n本模組是根據綠界官方 AIO 規格的全新實作，並非官方維護的 SDK 或是 fork 改寫版本。此模組的設計初衷是為了與官方最新的 API 規格一致、更貼近 JS 開發風格、提供 TypeScript 支援、盡可能完善的自動化測試以及更完善的文件說明。\n\n\u003cbr /\u003e\n\n\u003e 對應官方版本\n\u003e\n\u003e - [綠界科技全方位金流介接技術文件](https://www.ecpay.com.tw/Service/API_Dwnld)\n\u003e - 版本: V5.4.1\n\u003e - 文件編號: gw_p100\n\u003e - 發布日期: 2022-03-22\n\n\u003cbr /\u003e\n\n## Installation\n\n```\nnpm install --save node-ecpay-aio\n```\n\n## Features\n\n- 內建 TypeScript 支援\n- 按職責區分 Merchant (特店)、Payment (付款方式)、Query (查詢)、Action (操作)等類別\n- ATM、超商代碼與超商條碼可於後端建立訂單時一併獲得取號結果\n- 結構化的錯誤訊息，更易於程式流程控制\n- 使用 [yup](https://github.com/jquense/yup) 對 API 要求參數與相依條件進行防衛驗證\n- 自動為 REQ/RSP 產生與驗證 CheckMacValue，若驗證到接收響應之校驗碼不符會自動拋錯\n- 遠端查詢或操作作業失敗，會自動拋錯並附帶綠界傳回的錯誤碼、錯誤訊息與原始響應資料\n- 自動設定 derivable 的參數，如 `ChoosePayment`, `InvoiceMark` 等\n- 支援 Node.js v10.x 以上 (自動測試環境包含 v10.x, v12.x, v14.x 與 v16.x)\n- Serverless (Lambda) friendly\n\n\u003cbr /\u003e\n\n## Notes\n\n- 使用前建議先讀過官方文件與本模組 [User Guide](https://github.com/simenkid/node-ecpay-aio/wiki)\n- 歡迎發 Issue，但我不一定有時間修\n- 更歡迎發 PR（帶測試佳）或共同維護\n- 本模組基本穩定，但有些功能綠界沒有提供 Testing stage，自動化測試跑不到那些 cases。\n\n\u003cbr /\u003e\n\n## Updates\n\n- v0.2.2 (2022/09/29)\n  - 對 `OrderResultURL`, `ClientBackURL`, `ClientRedirectURL` 三個參數的驗證從必為 URL 改為不一定要為 URL，因在手機使用的情況可能會使用 deep link 重導。故現在開發者要自行保證 `OrderResultURL`, `ClientBackURL`, `ClientRedirectURL` 三個參數的格式。\n- v0.2.3 (2022/09/30)\n  - 對 URL 的驗證改為符合 IETF RFC3986 的格式 - `ReturnURL`, `PeriodReturnURL`, `PaymentInfoURL` 可以接受 http://localhost - v0.2.3 起的驗證不會保證你是否使用 `https` 開頭的網址，故生產時，請開發者要自行保證網址的合法性\n    \u003cbr /\u003e\n\n## License\n\nLicensed under [MIT](https://github.com/simenkid/node-ecpay-aio/blob/main/LICENSE).\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimenkid%2Fnode-ecpay-aio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimenkid%2Fnode-ecpay-aio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimenkid%2Fnode-ecpay-aio/lists"}