API ของ Dropbox Sign v3
SDK นี้สร้างขึ้นจากข้อกำหนด OpenAPI ที่ได้รับการดูแลอย่างเป็นทางการของเรา เราได้ทำการอัปเดตที่สำคัญที่แนะนำฟังก์ชันการทำงานใหม่ และสร้างความเท่าเทียมกันของฟีเจอร์ระหว่าง Dropbox Sign API และ SDK อย่างไรก็ตาม การเปลี่ยนแปลงบางส่วนเหล่านี้ถือว่า "เสียหาย" ในแง่ที่ว่าคุณจะต้องอัปเดตโค้ดที่มีอยู่เพื่อใช้ SDK ต่อไป โปรดดูคู่มือการย้ายข้อมูลนี้สำหรับข้อมูลเพิ่มเติม
Repo นี้ไม่ยอมรับปัญหาใหม่หรือคำขอดึงอีกต่อไป ปัญหาทั้งหมดหรือคำขอดึง จะต้อง เปิดกับ repo hellosign/hellosign-openapi!
คุณต้องทำการเปลี่ยนแปลงโค้ด SDK ในไฟล์หนวดภายในไดเร็กทอรี templates ที่สอดคล้องกับไฟล์ที่คุณต้องการอัปเดต
C# SDK นี้สร้างขึ้นโดยอัตโนมัติโดยโปรเจ็กต์ OpenAPI Generator:
คุณต้องติดตั้ง docker (หรือ podman ที่เชื่อมโยงกับ docker ) ขอแนะนำอย่างยิ่งให้ใช้นักเทียบท่าแบบไม่มีรูท
เรียกใช้สิ่งต่อไปนี้และทุกอย่างจะเสร็จสิ้นเพื่อคุณ:
./run-buildข้อควรสนใจ : การเปลี่ยนแปลงใด ๆ ที่คุณทำกับโค้ด SDK ที่คุณไม่ได้ทำกับไฟล์ OAS และ/หรือไฟล์เทมเพลตหนวด จะหายไป เมื่อคุณรันคำสั่งนี้
Dropbox Sign .NET SDK สามารถติดตั้งได้โดยใช้ตัวจัดการแพ็คเกจ NuGet ภายใต้ชื่อแพ็คเกจ Dropbox.Sign (รายละเอียดแพ็คเกจ)
คุณสามารถปฏิบัติตามการเริ่มต้นอย่างรวดเร็วของ NuGet เพื่อสร้างและเผยแพร่แพ็คเกจผ่าน 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 | คำอธิบาย |
|---|---|---|---|
| บัญชีApi | สร้างบัญชี | โพสต์ /บัญชี/สร้าง | สร้างบัญชี |
| บัญชีApi | บัญชีรับ | รับ / บัญชี | รับบัญชี |
| บัญชีApi | อัปเดตบัญชี | ใส่ /บัญชี | อัปเดตบัญชี |
| บัญชีApi | บัญชียืนยัน | โพสต์ /บัญชี/ยืนยัน | ยืนยันบัญชี |
| ApiAppApi | ApiAppCreate | โพสต์ /api_app | สร้างแอป API |
| ApiAppApi | ApiAppDelete | ลบ /api_app/{client_id} | ลบแอป API |
| ApiAppApi | ApiAppGet | รับ /api_app/{client_id} | รับแอป API |
| ApiAppApi | ApiAppList | รับ /api_app/list | แสดงรายการแอป API |
| ApiAppApi | ApiAppอัปเดต | ใส่ /api_app/{client_id} | อัปเดตแอป API |
| BulkSendJobApi | ส่งงานจำนวนมากรับ | รับ /bulk_send_job/{bulk_send_job_id} | รับงานส่งจำนวนมาก |
| BulkSendJobApi | BulkSendJobList | รับ /bulk_send_job/list | แสดงรายการงานส่งจำนวนมาก |
| API แบบฝัง | EmbeddedEditUrl | POST /embedded/edit_url/{template_id} | รับ URL แก้ไขเทมเพลตแบบฝัง |
| API แบบฝัง | EmbeddedSignUrl | GET /embedded/sign_url/{signature_id} | รับ URL เครื่องหมายแบบฝัง |
| โทรสารApi | โทรสารลบ | ลบ /แฟกซ์/{fax_id} | ลบแฟกซ์ |
| โทรสารApi | ไฟล์แฟกซ์ | รับ /แฟกซ์/ไฟล์/{fax_id} | แสดงรายการไฟล์แฟกซ์ |
| โทรสารApi | รับแฟกซ์ | รับ /แฟกซ์/{fax_id} | รับแฟกซ์ |
| โทรสารApi | รายการแฟกซ์ | รับ /แฟกซ์/รายการ | แสดงรายการแฟกซ์ |
| โทรสารApi | ส่งแฟกซ์ | โพสต์ /แฟกซ์/ส่ง | ส่งแฟกซ์ |
| แฟกซ์ไลน์Api | โทรสารLineAddUser | PUT /fax_line/add_user | เพิ่มผู้ใช้สายแฟกซ์ |
| แฟกซ์ไลน์Api | โทรสารไลน์รหัสพื้นที่รับ | รับ /fax_line/area_codes | รับรหัสพื้นที่สายแฟกซ์ที่มีอยู่ |
| แฟกซ์ไลน์Api | โทรสารไลน์สร้าง | โพสต์ /fax_line/create | ซื้อสายแฟกซ์ |
| แฟกซ์ไลน์Api | แฟกซ์ไลน์ลบ | ลบ /fax_line | ลบสายแฟกซ์ |
| แฟกซ์ไลน์Api | แฟกซ์ไลน์รับ | รับ /fax_line | รับสายแฟกซ์ |
| แฟกซ์ไลน์Api | รายการแฟกซ์ไลน์ | รับ /fax_line/list | แสดงรายการสายแฟกซ์ |
| แฟกซ์ไลน์Api | FaxLineRemoveUser | PUT /fax_line/remove_user | ลบการเข้าถึงสายแฟกซ์ |
| OAuthApi | OauthTokenสร้าง | POST /oauth/โทเค็น | สร้างโทเค็น OAuth |
| OAuthApi | OauthTokenรีเฟรช | POST /oauth/token?รีเฟรช | รีเฟรชโทเค็น OAuth |
| รายงานApi | รายงานสร้าง | โพสต์ /รายงาน/สร้าง | สร้างรายงาน |
| 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 | SignatureRequestCreateEmbedded | 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} | ดาวน์โหลดไฟล์เป็น Data Uri |
| SignatureRequestApi | SignatureRequestFilesAsFileUrl | รับ /signature_request/files_as_file_url/{signature_request_id} | ดาวน์โหลดไฟล์เป็น File Url |
| SignatureRequestApi | ลายเซ็นขอรับ | รับ /signature_request/{signature_request_id} | รับคำขอลายเซ็น |
| SignatureRequestApi | รายการคำขอลายเซ็น | รับ /signature_request/list | แสดงรายการคำขอลายเซ็น |
| SignatureRequestApi | ลายเซ็นขอปล่อยถือ | 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 | ลายเซ็นขอส่ง | POST /signature_request/ส่ง | ส่งคำขอลายเซ็น |
| SignatureRequestApi | SignatureRequestSendWithTemplate | POST /signature_request/send_with_template | ส่งพร้อมเทมเพลต |
| SignatureRequestApi | ลายเซ็นขออัปเดต | POST /signature_request/update/{signature_request_id} | อัปเดตคำขอลายเซ็น |
| ทีมเอพี | ทีมแอดเมมเบอร์ | PUT /ทีม/add_member | เพิ่มผู้ใช้เข้าทีม |
| ทีมเอพี | ทีมสร้าง | โพสต์ /ทีม/สร้าง | สร้างทีม |
| ทีมเอพี | ทีมลบ | ลบ /ทีม/ทำลาย | ลบทีม |
| ทีมเอพี | ทีมเก็ต | รับ /ทีม | รับทีม |
| ทีมเอพี | ข้อมูลทีม | รับ /ทีม/ข้อมูล | รับข้อมูลทีม |
| ทีมเอพี | คำเชิญทีม | รับ /ทีม/คำเชิญ | รายชื่อทีมเชิญ |
| ทีมเอพี | สมาชิกในทีม | รับ /ทีม/สมาชิก/{team_id} | รายชื่อสมาชิกทีม |
| ทีมเอพี | ทีมลบสมาชิก | โพสต์ /ทีม/remove_member | ลบผู้ใช้ออกจากทีม |
| ทีมเอพี | ทีมย่อยทีม | รับ /ทีม/sub_teams/{team_id} | รายชื่อทีมย่อย |
| ทีมเอพี | ทีมอัปเดต | วาง /ทีม | อัพเดททีมงาน |
| เทมเพลตApi | เทมเพลตเพิ่มผู้ใช้ | โพสต์ /template/add_user/{template_id} | เพิ่มผู้ใช้ลงในเทมเพลต |
| เทมเพลตApi | สร้างเทมเพลต | โพสต์ /เทมเพลต/สร้าง | สร้างเทมเพลต |
| เทมเพลตApi | เทมเพลตสร้างร่างแบบฝังตัว | POST /template/create_embedded_draft | สร้างร่างเทมเพลตแบบฝัง |
| เทมเพลตApi | แม่แบบลบ | โพสต์ /template/delete/{template_id} | ลบเทมเพลต |
| เทมเพลตApi | TemplateFiles | รับ /template/files/{template_id} | รับไฟล์เทมเพลต |
| เทมเพลตApi | TemplateFilesAsDataUri | รับ /template/files_as_data_uri/{template_id} | รับไฟล์เทมเพลตเป็น Data Uri |
| เทมเพลตApi | TemplateFilesAsFileUrl | รับ /template/files_as_file_url/{template_id} | รับไฟล์เทมเพลตเป็น URL ของไฟล์ |
| เทมเพลตApi | เทมเพลตGet | รับ /template/{template_id} | รับเทมเพลต |
| เทมเพลตApi | รายการเทมเพลต | รับ /เทมเพลต/รายการ | เทมเพลตรายการ |
| เทมเพลตApi | เทมเพลตลบผู้ใช้ | โพสต์ /template/remove_user/{template_id} | ลบผู้ใช้ออกจากเทมเพลต |
| เทมเพลตApi | TemplateUpdateFiles | โพสต์ /template/update_files/{template_id} | อัปเดตไฟล์เทมเพลต |
| DraftApi ที่ไม่มีการอ้างสิทธิ์ | ไม่มีการอ้างสิทธิ์DraftCreate | POST /unclaimed_draft/สร้าง | สร้างฉบับร่างที่ไม่มีการอ้างสิทธิ์ |
| DraftApi ที่ไม่มีการอ้างสิทธิ์ | ไม่มีการอ้างสิทธิ์DraftCreateEmbedded | POST /unclaimed_draft/create_embedded | สร้างฉบับร่างที่ไม่มีการอ้างสิทธิ์แบบฝัง |
| DraftApi ที่ไม่มีการอ้างสิทธิ์ | DraftCreateEmbeddedWithTemplate ที่ไม่มีการอ้างสิทธิ์ | POST /unclaimed_draft/create_embedded_with_template | สร้างแบบร่างที่ไม่มีการอ้างสิทธิ์แบบฝังด้วยเทมเพลต |
| DraftApi ที่ไม่มีการอ้างสิทธิ์ | ฉบับร่างที่ไม่มีการอ้างสิทธิ์แก้ไขและส่งอีกครั้ง | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | แก้ไขและส่งฉบับร่างที่ไม่มีการอ้างสิทธิ์อีกครั้ง |
รูปแบบการตรวจสอบสิทธิ์ที่กำหนดไว้สำหรับ API:
