Dropbox Sign v3 API
이 SDK는 공식적으로 유지 관리되는 OpenAPI 사양에서 생성됩니다. Dropbox Sign API와 SDK 간에 새로운 기능을 도입하고 기능 패리티를 만드는 중요한 업데이트를 진행했습니다. 그러나 이러한 변경 사항 중 일부는 SDK를 계속 사용하려면 기존 코드를 업데이트해야 한다는 점에서 "중요한" 변경 사항으로 간주됩니다. 자세한 내용은 이 마이그레이션 가이드를 참조하세요.
이 저장소는 더 이상 새로운 이슈나 Pull Request를 받아들이지 않습니다. 모든 이슈 또는 끌어오기 요청은 hellosign/hellosign-openapi 저장소에 대해 열려야 합니다 !
업데이트하려는 파일에 해당하는 templates 디렉터리 내의 콧수염 파일에서 SDK 코드를 변경해야 합니다.
이 C# SDK는 OpenAPI Generator 프로젝트에 의해 자동으로 생성됩니다.
docker (또는 docker 에 연결된 podman )가 설치되어 있어야 합니다. 루트리스 도커를 사용하는 것이 좋습니다.
다음을 실행하면 모든 작업이 완료됩니다.
./run-build주의 : OAS 파일 및/또는 콧수염 템플릿 파일에 적용하지 않은 SDK 코드 변경 사항은 이 명령을 실행하면 손실됩니다 .
Dropbox Sign .NET SDK는 NuGet 패키지 관리자를 사용하여 패키지 이름 Dropbox.Sign (패키지 세부 정보)으로 설치할 수 있습니다.
NuGet 빠른 시작에 따라 dotnet CLI를 통해 패키지를 만들고 게시할 수 있습니다. 또는 Visual Studio를 사용하여 만들고 게시할 수 있습니다.
또는 .nupkg를 로컬 피드나 다른 호스트에 게시하고 평소처럼 NuGet을 통해 사용할 수 있습니다.
HTTP 프록시와 함께 API 클라이언트를 사용하려면 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 | 계정생성 | POST /계정/생성 | 계정 만들기 |
| AccountApi | 계정 가져오기 | GET /계정 | 계정 만들기 |
| AccountApi | 계정 업데이트 | PUT /계정 | 계정 업데이트 |
| AccountApi | 계정확인 | POST /계정/확인 | 계정 확인 |
| ApiAppApi | APIAppCreate | POST /api_app | API 앱 만들기 |
| ApiAppApi | ApiApp삭제 | /api_app/{client_id} 삭제 | API 앱 삭제 |
| ApiAppApi | APIAppGet | GET /api_app/{client_id} | API 앱 받기 |
| ApiAppApi | APIAppList | GET /api_app/list | API 앱 나열 |
| ApiAppApi | APIApp업데이트 | PUT /api_app/{client_id} | API 앱 업데이트 |
| 대량 보내기JobApi | 대량 보내기작업 가져오기 | GET /bulk_send_job/{bulk_send_job_id} | 대량 전송 작업 가져오기 |
| 대량 보내기JobApi | 대량 보내기작업 목록 | GET /bulk_send_job/list | 대량 전송 작업 나열 |
| EmbeddedApi | EmbeddedEditUrl | POST /embedded/edit_url/{template_id} | 포함된 템플릿 편집 URL 가져오기 |
| EmbeddedApi | 내장된 서명 URL | GET /embedded/sign_url/{signature_id} | 내장된 서명 URL 가져오기 |
| FaxApi | 팩스삭제 | 삭제 /팩스/{팩스_ID} | 팩스 삭제 |
| FaxApi | 팩스파일 | GET /팩스/파일/{fax_id} | 팩스 파일 나열 |
| FaxApi | 팩스받기 | GET /팩스/{fax_id} | 팩스 받기 |
| FaxApi | 팩스 목록 | GET /팩스/목록 | 팩스 목록 |
| FaxApi | 팩스보내기 | POST /팩스/보내기 | 팩스 보내기 |
| FaxLineApi | 팩스라인사용자 추가 | PUT /fax_line/add_user | 팩스 회선 사용자 추가 |
| FaxLineApi | 팩스라인영역코드가져오기 | GET /fax_line/area_codes | 사용 가능한 팩스 회선 지역 번호 얻기 |
| FaxLineApi | 팩스라인만들기 | POST /fax_line/create | 팩스 회선 구매 |
| FaxLineApi | 팩스라인삭제 | 삭제 /fax_line | 팩스 회선 삭제 |
| FaxLineApi | 팩스라인가져오기 | 받기 /fax_line | 팩스 회선 받기 |
| FaxLineApi | 팩스라인목록 | GET /팩스라인/목록 | 팩스 회선 나열 |
| FaxLineApi | 팩스라인사용자 제거 | PUT /fax_line/remove_user | 팩스 회선 액세스 제거 |
| OAuthApi | OauthToken생성 | POST /oauth/토큰 | OAuth 토큰 생성 |
| OAuthApi | OauthToken새로 고침 | POST /oauth/token?refresh | OAuth 토큰 새로 고침 |
| 보고서Api | 보고서만들기 | POST /보고/생성 | 보고서 작성 |
| 서명요청Api | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | 템플릿으로 포함된 대량 보내기 |
| 서명요청Api | 서명요청대량SendWithTemplate | POST /signature_request/bulk_send_with_template | 템플릿으로 대량보내기 |
| 서명요청Api | 서명요청취소 | POST /signature_request/cancel/{signature_request_id} | 불완전한 서명 요청 취소 |
| 서명요청Api | 서명요청CreateEmbedded | POST /signature_request/create_embedded | 포함된 서명 요청 생성 |
| 서명요청Api | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | 템플릿을 사용하여 포함된 서명 요청 생성 |
| 서명요청Api | 서명요청 파일 | GET /signature_request/files/{signature_request_id} | 파일 다운로드 |
| 서명요청Api | SignatureRequestFilesAsDataUri | GET /signature_request/files_as_data_uri/{signature_request_id} | 파일을 데이터 URI로 다운로드 |
| 서명요청Api | SignatureRequestFilesAsFileUrl | GET /signature_request/files_as_file_url/{signature_request_id} | 파일 URL로 파일 다운로드 |
| 서명요청Api | 서명요청받기 | GET /signature_request/{signature_request_id} | 서명 요청 받기 |
| 서명요청Api | 서명요청 목록 | GET /서명_요청/목록 | 서명 요청 나열 |
| 서명요청Api | 서명요청릴리스보류 | POST /signature_request/release_hold/{signature_request_id} | 보류 서명 요청 해제 |
| 서명요청Api | 서명요청알림 | POST /signature_request/remind/{signature_request_id} | 요청 알림 보내기 |
| 서명요청Api | 서명요청제거 | POST /signature_request/remove/{signature_request_id} | 서명 요청 액세스 제거 |
| 서명요청Api | 서명요청보내기 | POST /signature_request/send | 서명 요청 보내기 |
| 서명요청Api | 서명요청SendWithTemplate | POST /signature_request/send_with_template | 템플릿으로 보내기 |
| 서명요청Api | 서명요청업데이트 | POST /signature_request/update/{signature_request_id} | 서명 요청 업데이트 |
| TeamApi | 팀 구성원 추가 | PUT /팀/add_member | 팀에 사용자 추가 |
| TeamApi | 팀 생성 | POST /팀/생성 | 팀 만들기 |
| TeamApi | 팀삭제 | 삭제 /팀/파괴 | 팀 삭제 |
| TeamApi | 팀겟 | GET /팀 | 팀 가져오기 |
| TeamApi | 팀정보 | GET /팀/정보 | 팀 정보 얻기 |
| TeamApi | 팀 초대 | /팀/초대 받기 | 팀 초대 나열 |
| TeamApi | 팀원 | GET /team/members/{team_id} | 팀 구성원 나열 |
| TeamApi | 팀 구성원 제거 | POST /팀/remove_member | 팀에서 사용자 제거 |
| TeamApi | 팀하위팀 | /team/sub_teams/{team_id} 가져오기 | 하위 팀 나열 |
| TeamApi | 팀업데이트 | PUT /팀 | 업데이트 팀 |
| 템플릿Api | 템플릿추가사용자 | POST /template/add_user/{template_id} | 템플릿에 사용자 추가 |
| 템플릿Api | 템플릿 생성 | POST /템플릿/생성 | 템플릿 생성 |
| 템플릿Api | 템플릿생성임베디드초안 | POST /template/create_embedded_draft | 포함된 템플릿 초안 만들기 |
| 템플릿Api | 템플릿삭제 | POST /template/delete/{template_id} | 템플릿 삭제 |
| 템플릿Api | 템플릿파일 | GET /template/files/{template_id} | 템플릿 파일 가져오기 |
| 템플릿Api | TemplateFilesAsDataUri | GET /template/files_as_data_uri/{template_id} | 템플릿 파일을 데이터 Uri로 가져오기 |
| 템플릿Api | 템플릿파일AsFileUrl | GET /template/files_as_file_url/{template_id} | 템플릿 파일을 파일 URL로 가져오기 |
| 템플릿Api | 템플릿 가져오기 | GET /template/{template_id} | 템플릿 가져오기 |
| 템플릿Api | 템플릿 목록 | GET /템플릿/목록 | 목록 템플릿 |
| 템플릿Api | 템플릿사용자 제거 | POST /template/remove_user/{template_id} | 템플릿에서 사용자 제거 |
| 템플릿Api | 템플릿업데이트파일 | POST /template/update_files/{template_id} | 템플릿 파일 업데이트 |
| 청구되지 않은 초안 API | 청구되지 않은 초안생성 | POST /unclaimed_draft/create | 청구되지 않은 초안 생성 |
| 청구되지 않은 초안 API | 청구되지 않은 초안CreateEmbedded | POST /unclaimed_draft/create_embedded | 포함된 청구되지 않은 초안 생성 |
| 청구되지 않은 초안 API | 청구되지 않은 초안CreateEmbeddedWithTemplate | POST /unclaimed_draft/create_embedded_with_template | 템플릿을 사용하여 포함된 청구되지 않은 초안 생성 |
| 청구되지 않은 초안 API | 청구되지 않은 초안편집 및 재전송 | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | 청구되지 않은 초안 편집 및 재전송 |
API에 대해 정의된 인증 체계:
