الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

قابل للتوقيع

يوفر العميل القابل للتوقيع واجهة روبي بسيطة لواجهة برمجة التطبيقات القابلة للتوقيع.

تثبيت

أضف هذا السطر إلى ملف 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 )

قد يحتوي المستند أيضًا على حقول دمج (راجع الوثائق القابلة للتوقيع)

قم ببناء حفلة 

 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 في هذا المستودع حتى تتمكن من تشغيل المواصفات دون الوصول إلى Signable API كما يلي: 

 bundle exec rspec

إذا كنت بحاجة إلى إعادة تسجيل التفاعلات بين كود Ruby وSignable API، فيمكنك تحديد مفتاح API للاختبارات لاستخدامه كما يلي: 

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

إذا كان لديك واجهة برمجة تطبيقات غير صالحة أو مفقودة، فسوف ترى خطأً كما يلي: 

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

ملحوظة:

  • تسجيلات VCR لها وقت انتهاء الصلاحية، لذا قد تضطر إلى إعادة تسجيلها حتى لو لم تقم بإجراء أي تغييرات
  • مجموعة الاختبار مدمرة لذا يرجى استخدام حساب تجريبي قابل للتوقيع فقط. يتطلب الحساب مورد قالب واحدًا حتى يتم تشغيل مجموعة الاختبار.

للحصول على مفتاح واجهة برمجة تطبيقات صالح للتوقيع، قم بتسجيل الدخول إلى حسابك القابل للتوقيع وانتقل إلى إعدادات الشركة ← Api & Webhooks وانقر على "إضافة مفتاح واجهة برمجة التطبيقات" لإنشاء مفتاح. ننصحك بحذف المفتاح عند الانتهاء منه.

المساهمة

  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. إنشاء طلب سحب جديد
يوسع
معلومات إضافية
نوصي لك
أخبار ذات صلة الكل