signable

可簽名

可簽署客戶端為 Signable API 提供了一個簡單的 Ruby 介面。

安裝

將此行新增至應用程式的 Gemfile 中：

 gem 'signable'

然後執行：

 $ bundle

或自己安裝：

 $ gem install signable

用法

配置

 Signable . configure do | config |
  config . base_url = ENV . fetch ( 'SIGNABLE_BASE_URL' )
  config . api_key  = ENV . fetch ( 'SIGNABLE_API_KEY' )
end

檢索模板

 Signable :: Template . find 'fingerprint'

建立一個文檔

 Signable :: Document . new ( template_fingerprint : fingerprint , title : title )

文件也可能包含 merge_fields（請參閱可簽署文件）

建立一個聚會

 Signable :: Party . new ( id : id , name : 'name' , email : 'email' )

可以從範本中檢索參與方 ID

建立一個信封

 envelope = Signable :: Envelope . new title : 'title' , redirect_url : 'https://www.autoenrolment.co.uk'
envelope . documents = documents
envelope . parties = parties

envelope . save 

測試

測試套件是 RSpec，並使用 VCR 來測試 API 呼叫。

VCR 盒式磁帶包含在此儲存庫中，因此您可以執行規格而無需點擊 Signable API，如下所示：

 bundle exec rspec

如果您需要重新記錄 Ruby 程式碼和 Signable API 之間的交互，您可以指定一個 API 金鑰供測試使用，如下所示：

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

如果您的 API 無效或缺失，您將看到以下錯誤：

 Authentication failed . Either the API Key or password was blank .

筆記：

• VCR 錄音有有效期，因此即使您沒有進行任何更改，您也可能被迫重新錄製它們
• 此測試套件具有破壞性，因此請僅使用測試可簽署帳戶。該帳戶需要一個模板資源才能執行測試套件。

若要取得有效的 Signable API 金鑰，請登入您的 Signable 帳戶並導覽至“公司設定”→“Api 和 Webhooks”，然後按一下“新增 API 金鑰”以產生金鑰。我們建議您在使用完該金鑰後將其刪除。

貢獻

1. 分叉它（http://github.com//signable/fork）
2. 建立您的功能分支（ git checkout -b my-new-feature ）
3. 提交您的更改（ git commit -am 'Add some feature' ）
4. 推送到分支（ git push origin my-new-feature ）
5. 建立新的拉取請求