ดาวน์โหลดที่ลงนามได้ - ดาวน์โหลดซอร์สโค้ดที่ลงนามได้

signable

ซอร์สโค้ดอื่น ๆ

v0.3.0

ดาวน์โหลด

ลงชื่อได้

ไคลเอ็นต์ที่ลงนามได้จัดเตรียมอินเทอร์เฟซ Ruby อย่างง่ายให้กับ Signable API

การติดตั้ง

เพิ่มบรรทัดนี้ลงใน 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' )

รหัสปาร์ตี้สามารถดึงมาจากเทมเพลต

สร้างซองจดหมาย

 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 Cassette รวมอยู่ในพื้นที่เก็บข้อมูลนี้ ดังนั้นคุณจึงสามารถรันข้อมูลจำเพาะได้โดยไม่ต้องกดปุ่ม 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" เพื่อสร้างคีย์ เราขอแนะนำให้คุณลบคีย์เมื่อดำเนินการเสร็จแล้ว