SSU项目技术文档

1. 安装指南

环境要求

• 操作系统：Linux 或 Mac OS X（Windows 不支持）
• XulRunner：一个由 Mozilla 提供的、可定制和可脚本的浏览器环境

安装步骤

1. 克隆 SSU 仓库：

   $ git clone https://github.com/wesabe/ssu
   

2. 根据操作系统安装 XulRunner：

   • 对于 Linux，使用包管理器（例如 apt-get）进行安装。
   • 对于 Mac OS X，运行以下命令进行安装：

     ssu$ ./bootstrap
     

3. 启动 SSU 应用程序：

   ssu$ bin/server
   

4. 生成凭证文件：

   ssu$ bundle
   ssu$ bundle exec script/generate credential <银行域名> <银行名称>
   

   例如，对于 Chase 银行：

   ssu$ bundle exec script/generate credential com.chase Chase
   

5. 修改生成的凭证文件，将 FIUSERNAME 和 FIPASSWORD 替换为实际的银行用户名和密码。

2. 项目的使用说明

1. 启动控制台：

   ssu$ script/console
   

2. 创建一个任务：

   >> job = Job.create <银行名称>
   

   例如，对于 Chase 银行：

   >> job = Job.create 'chase'
   

3. 列出已下载的银行对账单：

   >> list = Statement.all
   >> list.first.read
   

3. 项目API使用文档

SSU 提供了一个基于 HTTP 的 API 来管理任务和获取数据。

列出所有对账单

POST /_legacy HTTP/1.0

{"action": "statement.list"}

开始一个任务

POST /_legacy HTTP/1.0
Content-Type: application/json
Content-Length: <请求体长度>

{"action": "job.start", "body": {"fid": "<银行域名>", "creds": {"username": "<用户名>", "password": "<密码>"}}}

响应示例

• 成功响应：

  HTTP/1.0 200 OK
  Content-Type: application/json
  
  {"status": "ok", "statements": ["1D8787AA-6D2D-0001-DFF3-9EB052301CD4"]}
  

• 错误响应：

  {"status": "error", "error": "ReferenceError: foo is not defined"}
  

注意： / Legacy 路线是一个临时的向后兼容措施，最终将被基于 REST 的路线（例如 GET /statements，POST /jobs 等）替换。

4. 项目安装方式

SSU 的安装方式主要依赖于 Git 进行代码克隆，以及系统的包管理器或提供的脚本进行 XulRunner 的安装。具体步骤如下：

1. 使用 Git 克隆项目仓库。
2. 根据操作系统安装 XulRunner。
3. 启动 SSU 服务。
4. 生成并配置凭证文件。
5. 通过控制台和管理 API 使用项目功能。