Dropbox Sign v3 API
تم إنشاء SDK هذا من مواصفات OpenAPI التي تم الحفاظ عليها رسميًا. لقد أجرينا تحديثات مهمة تقدم وظائف جديدة وتنشئ تكافؤًا في الميزات بين Dropbox Sign API وSDK. ومع ذلك، تعتبر بعض هذه التغييرات "معطلة" بمعنى أنها ستتطلب منك تحديث التعليمات البرمجية الموجودة لديك لمواصلة استخدام SDK. يرجى الرجوع إلى دليل الهجرة هذا لمزيد من المعلومات.
لم يعد هذا الريبو يقبل مشكلات جديدة أو طلبات سحب. يجب فتح جميع المشكلات أو طلبات السحب مقابل hellosign/hellosign-openapi repo!
يجب عليك إجراء تغييرات على كود SDK في ملف الشارب داخل دليل templates الذي يتوافق مع الملف الذي تريد تحديثه.
يتم إنشاء C# SDK تلقائيًا بواسطة مشروع OpenAPI Generator:
يجب أن يكون لديك docker (أو podman مرتبط بعامل docker ) مثبتًا. يوصى بشدة باستخدام عامل الإرساء بدون جذور.
قم بتشغيل ما يلي ويتم كل شيء من أجلك:
./run-buildتنبيه : سيتم فقدان أي تغييرات أجريتها على كود SDK ولم تقم بإجرائها على ملف OAS و/أو ملفات قالب الشارب عند تشغيل هذا الأمر.
يمكن تثبيت Dropbox Sign .NET SDK باستخدام مدير الحزم NuGet، تحت اسم الحزمة Dropbox.Sign (تفاصيل الحزمة).
يمكنك اتباع NuGet Quickstart لإنشاء الحزمة ونشرها عبر dotnet CLI. أو يمكنك الإنشاء والنشر باستخدام Visual Studio.
وبدلاً من ذلك، يمكن نشر ملف .nupkg على خلاصة محلية أو مضيف آخر واستهلاكه عبر NuGet كالمعتاد.
لاستخدام عميل API مع وكيل HTTP، قم بإعداد System.Net.WebProxy
Configuration c = new Configuration ( ) ;
System . Net . WebProxy webProxy = new System . Net . WebProxy ( " http://myProxyUrl:80/ " ) ;
webProxy . Credentials = System . Net . CredentialCache . DefaultCredentials ;
c . Proxy = webProxy ; using System ;
using Dropbox . Sign . Api ;
using Dropbox . Sign . Client ;
using Dropbox . Sign . Model ;
public class Example
{
public static void Main ( )
{
var config = new Configuration ( ) ;
// Configure HTTP basic authorization: api_key
config . Username = " YOUR_API_KEY " ;
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var accountApi = new AccountApi ( config ) ;
var data = new AccountCreateRequest (
emailAddress : " [email protected] "
) ;
try
{
var result = accountApi . AccountCreate ( data ) ;
Console . WriteLine ( result ) ;
}
catch ( ApiException e )
{
Console . WriteLine ( " Exception when calling Dropbox Sign API: " + e . Message ) ;
Console . WriteLine ( " Status Code: " + e . ErrorCode ) ;
Console . WriteLine ( e . StackTrace ) ;
}
}
} جميع عناوين URI مرتبطة بـ https://api.hellosign.com/v3
| فصل | طريقة | طلب HTTP | وصف |
|---|---|---|---|
| AccountApi | إنشاء حساب | نشر /الحساب/إنشاء | إنشاء حساب |
| AccountApi | AccountGet | الحصول على /الحساب | احصل على الحساب |
| AccountApi | تحديث الحساب | وضع /الحساب | تحديث الحساب |
| AccountApi | التحقق من الحساب | نشر /الحساب/التحقق | التحقق من الحساب |
| APIAppApi | APIAppCreate | نشر /api_app | إنشاء تطبيق API |
| APIAppApi | APIAppDelete | حذف /api_app/{client_id} | حذف تطبيق API |
| APIAppApi | APIAppGet | احصل على /api_app/{client_id} | احصل على تطبيق API |
| APIAppApi | قائمة التطبيقات | احصل على /api_app/list | قائمة تطبيقات API |
| APIAppApi | تحديث API | ضع /api_app/{client_id} | تحديث تطبيق API |
| BulkSendJobApi | BulkSendJobGet | احصل على /bulk_send_job/{bulk_send_job_id} | احصل على وظيفة الإرسال بالجملة |
| BulkSendJobApi | قائمة إرسال بالجملة | احصل على /bulk_send_job/list | قائمة وظائف الإرسال بالجملة |
| EmbeddedApi | EmbeddedEditUrl | مشاركة /embedded/edit_url/{template_id} | احصل على عنوان URL لتحرير القالب المضمن |
| EmbeddedApi | EmbeddedSignUrl | الحصول على /embedded/sign_url/{signature_id} | احصل على عنوان URL للتوقيع المضمن |
| FaxApi | حذف الفاكس | حذف /فاكس/{fax_id} | حذف الفاكس |
| FaxApi | ملفات الفاكس | الحصول على /فاكس/ملفات/{fax_id} | قائمة ملفات الفاكس |
| FaxApi | فاكسجيت | احصل على /فاكس/{fax_id} | احصل على الفاكس |
| FaxApi | قائمة الفاكس | احصل على /فاكس/قائمة | قوائم الفاكسات |
| FaxApi | إرسال فاكس | بريد / فاكس / إرسال | إرسال الفاكس |
| FaxLineApi | FaxLineAddUser | ضع /fax_line/add_user | إضافة مستخدم خط الفاكس |
| FaxLineApi | FaxLineAreaCodeGet | احصل على /fax_line/area_codes | احصل على رموز منطقة خط الفاكس المتوفرة |
| FaxLineApi | إنشاء فاكس | بوست /fax_line/create | شراء خط فاكس |
| FaxLineApi | FaxLineDelete | احذف /fax_line | حذف خط الفاكس |
| FaxLineApi | FaxLineGet | احصل على /fax_line | احصل على خط الفاكس |
| FaxLineApi | قائمة خط الفاكس | احصل على /fax_line/list | قائمة خطوط الفاكس |
| FaxLineApi | FaxLineRemoveUser | ضع /fax_line/remove_user | قم بإزالة الوصول إلى خط الفاكس |
| OAuthApi | OauthTokenGenerate | بوست /oauth/الرمز المميز | إنشاء رمز OAuth |
| OAuthApi | OauthTokenRefresh | POST /oauth/token?refresh | تحديث رمز OAuth |
| ReportApi | إنشاء تقرير | نشر / تقرير / إنشاء | إنشاء تقرير |
| SignatureRequestApi | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | إرسال مجمع مضمن مع القالب |
| SignatureRequestApi | SignatureRequestBulkSendWithTemplate | POST /signature_request/bulk_send_with_template | إرسال بالجملة مع القالب |
| SignatureRequestApi | إلغاء طلب التوقيع | POST /signature_request/cancel/{signature_request_id} | إلغاء طلب التوقيع غير المكتمل |
| SignatureRequestApi | طلب التوقيعإنشاء Embedded | POST /signature_request/create_embedded | إنشاء طلب التوقيع المضمن |
| SignatureRequestApi | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | إنشاء طلب توقيع مضمن مع القالب |
| SignatureRequestApi | ملفات طلب التوقيع | الحصول على /signature_request/files/{signature_request_id} | تنزيل الملفات |
| SignatureRequestApi | SignatureRequestFilesAsDataUri | الحصول على /signature_request/files_as_data_uri/{signature_request_id} | تنزيل الملفات كبيانات Uri |
| SignatureRequestApi | SignatureRequestFilesAsFileUrl | الحصول على /signature_request/files_as_file_url/{signature_request_id} | تنزيل الملفات كعنوان URL للملف |
| SignatureRequestApi | طلب التوقيعGet | الحصول على /signature_request/{signature_request_id} | الحصول على طلب التوقيع |
| SignatureRequestApi | قائمة طلبات التوقيع | احصل على /signature_request/list | قائمة طلبات التوقيع |
| SignatureRequestApi | SignatureRequestReleaseHold | POST /signature_request/release_hold/{signature_request_id} | تحرير طلب التوقيع قيد الانتظار |
| SignatureRequestApi | طلب التوقيعتذكير | POST /signature_request/remind/{signature_request_id} | إرسال طلب تذكير |
| SignatureRequestApi | طلب التوقيعإزالة | POST /signature_request/remove/{signature_request_id} | إزالة الوصول لطلب التوقيع |
| SignatureRequestApi | طلب التوقيعإرسال | بوست /signature_request/send | إرسال طلب التوقيع |
| SignatureRequestApi | SignatureRequestSendWithTemplate | POST /signature_request/send_with_template | أرسل مع القالب |
| SignatureRequestApi | تحديث طلب التوقيع | POST /signature_request/update/{signature_request_id} | تحديث طلب التوقيع |
| TeamApi | TeamAddMember | ضع /team/add_member | إضافة مستخدم إلى الفريق |
| TeamApi | إنشاء فريق | نشر / فريق / إنشاء | إنشاء فريق |
| TeamApi | حذف الفريق | حذف / فريق / تدمير | حذف الفريق |
| TeamApi | TeamGet | الحصول على / فريق | احصل على الفريق |
| TeamApi | معلومات الفريق | الحصول على / فريق / معلومات | الحصول على معلومات الفريق |
| TeamApi | TeamInvites | الحصول على / فريق / يدعو | قائمة دعوات الفريق |
| TeamApi | أعضاء الفريق | الحصول على /team/members/{team_id} | قائمة أعضاء الفريق |
| TeamApi | TeamRemoveMember | POST /team/remove_member | إزالة المستخدم من الفريق |
| TeamApi | TeamSubTeams | الحصول على /team/sub_teams/{team_id} | قائمة الفرق الفرعية |
| TeamApi | تحديث الفريق | وضع / فريق | فريق التحديث |
| قالب API | قالب إضافة مستخدم | POST /template/add_user/{template_id} | إضافة مستخدم إلى القالب |
| قالب API | إنشاء قالب | نشر /قالب/إنشاء | إنشاء قالب |
| قالب API | إنشاء قالب مسودة مضمنة | POST /template/create_embedded_draft | إنشاء مسودة قالب مضمن |
| قالب API | حذف القالب | نشر /قالب/حذف/{template_id} | حذف القالب |
| قالب API | ملفات القالب | الحصول على /template/files/{template_id} | الحصول على ملفات القالب |
| قالب API | TemplateFilesAsDataUri | الحصول على /template/files_as_data_uri/{template_id} | احصل على ملفات القالب كبيانات Uri |
| قالب API | TemplateFilesAsFileUrl | الحصول على /template/files_as_file_url/{template_id} | احصل على ملفات القالب كعنوان URL للملف |
| قالب API | احصل على القالب | الحصول على /قالب/{template_id} | احصل على القالب |
| قالب API | قائمة القوالب | الحصول على /قالب/قائمة | قوالب القائمة |
| قالب API | قالب إزالة المستخدم | نشر /template/remove_user/{template_id} | إزالة المستخدم من القالب |
| قالب API | ملفات تحديث القالب | نشر /template/update_files/{template_id} | تحديث ملفات القالب |
| UnclaimedDraftApi | UnclaimedDraftCreate | POST /unclaimed_draft/create | إنشاء مسودة لم تتم المطالبة بها |
| UnclaimedDraftApi | مسودة إنشاء مضمنة لم تتم المطالبة بها | POST /unclaimed_draft/create_embedded | إنشاء مسودة مضمنة لم تتم المطالبة بها |
| UnclaimedDraftApi | مسودة غير مُطالب بها، إنشاء مُضمنة مع قالب | POST /unclaimed_draft/create_embedded_with_template | قم بإنشاء مسودة مضمنة غير مُطالب بها باستخدام القالب |
| UnclaimedDraftApi | مسودة تحرير وإعادة إرسال غير مُطالب بها | مشاركة /unclaimed_draft/edit_and_resend/{signature_request_id} | تحرير وإعادة إرسال المسودة غير المطالب بها |
أنظمة المصادقة المحددة لواجهة برمجة التطبيقات (API):
