API Dropbox Sign v3
Этот SDK создан на основе нашей официально поддерживаемой спецификации OpenAPI. Мы внесли важные обновления, которые добавляют новые функциональные возможности и обеспечивают равенство функций Dropbox Sign API и SDK. Однако некоторые из этих изменений считаются «критическими» в том смысле, что они потребуют от вас обновления существующего кода, чтобы продолжить использование SDK. Пожалуйста, обратитесь к этому руководству по миграции для получения дополнительной информации.
Этот репозиторий больше не принимает новые задачи или запросы на включение. Все задачи или запросы на включение должны открываться в репозитории hellosign/hellosign-openapi!
Вы должны внести изменения в код SDK в файле усов в каталоге templates , который соответствует файлу, который вы хотите обновить.
Этот C# SDK автоматически создается проектом OpenAPI Generator:
У вас должен быть установлен docker (или podman связанный с docker ). Настоятельно рекомендуется использовать докер без root-прав.
Запустите следующее, и все будет сделано за вас:
./run-buildВнимание : любые изменения, внесенные вами в код SDK, которые вы не внесли в файл OAS и/или файлы шаблонов усов , будут потеряны при запуске этой команды.
SDK Dropbox Sign .NET можно установить с помощью диспетчера пакетов NuGet под именем пакета Dropbox.Sign (сведения о пакете).
Вы можете воспользоваться кратким руководством по NuGet, чтобы создать и опубликовать пакет через интерфейс командной строки dotnet. Или вы можете создавать и публиковать с помощью 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 аккаунта | АккаунтСоздать | POST /аккаунт/создать | Зарегистрироваться |
| API аккаунта | АккаунтПолучить | ПОЛУЧИТЬ /аккаунт | Получить аккаунт |
| API аккаунта | Обновление аккаунта | ПУТ /аккаунт | Обновить учетную запись |
| API аккаунта | АккаунтПодтвердить | POST /аккаунт/проверить | Подтвердить аккаунт |
| АпиAppApi | ApiAppCreate | ПОСТ /api_app | Создать приложение API |
| АпиAppApi | APIAppDelete | УДАЛИТЬ /api_app/{client_id} | Удалить приложение API |
| АпиAppApi | ApiAppGet | ПОЛУЧИТЬ /api_app/{client_id} | Получить API-приложение |
| АпиAppApi | АпиAppList | ПОЛУЧИТЬ /api_app/список | Получение списка приложений API |
| АпиAppApi | APIAppUpdate | PUT /api_app/{client_id} | Обновить приложение API |
| Массовая рассылкаSendJobApi | Массовая отправка заданияПолучить | GET /bulk_send_job/{bulk_send_job_id} | Получить задание на массовую отправку |
| Массовая рассылкаSendJobApi | Массовая отправка списка заданий | ПОЛУЧИТЬ /bulk_send_job/список | Получение списка заданий массовой рассылки |
| Встроенный API | Встроенный EditUrl | POST /embedded/edit_url/{template_id} | Получить встроенный шаблон Изменить URL-адрес |
| Встроенный API | ВстроенныйSignUrl | ПОЛУЧИТЬ /embedded/sign_url/{signature_id} | Получить встроенный URL-адрес подписи |
| ФаксАпи | ФаксУдалить | УДАЛИТЬ /факс/{fax_id} | Удалить факс |
| ФаксАпи | ФаксФайлы | ПОЛУЧИТЬ /факс/файлы/{fax_id} | Получение списка файлов факса |
| ФаксАпи | Получить факс | ПОЛУЧИТЬ /факс/{fax_id} | Получить факс |
| ФаксАпи | Список факсов | ПОЛУЧИТЬ /факс/список | Списки факсов |
| ФаксАпи | ФаксОтправить | Почта /факс/отправить | Отправить факс |
| ФаксЛайнАпи | FaxLineAddUser | PUT /fax_line/add_user | Добавить пользователя факс-линии |
| ФаксЛайнАпи | ФаксЛинияОбластьКодПолучить | ПОЛУЧИТЬ /fax_line/area_codes | Получите доступные коды регионов факс-линий |
| ФаксЛайнАпи | ФаксЛинияСоздать | POST /fax_line/создать | Купить факсовую линию |
| ФаксЛайнАпи | ФаксЛинияУдалить | УДАЛИТЬ / линия_факса | Удалить линию факса |
| ФаксЛайнАпи | FaxLineGet | ПОЛУЧИТЬ /факс_линия | Получить факс |
| ФаксЛайнАпи | Список линий факсов | ПОЛУЧИТЬ /fax_line/список | Список линий факса |
| ФаксЛайнАпи | ФаксЛинияУдалитьПользователя | PUT /fax_line/remove_user | Удалить доступ к линии факса |
| ОАутАпи | OauthTokenСоздать | POST /oauth/токен | Создание токена OAuth |
| ОАутАпи | OauthTokenОбновить | POST /oauth/токен?обновить | Обновление токена OAuth |
| ReportApi | ОтчетСоздать | POST /отчет/создать | Создать отчет |
| 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 | ПодписьRequestCreateEmbedded | POST /signature_request/create_embedded | Создать встроенный запрос подписи |
| SignatureRequestApi | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | Создайте встроенный запрос подписи с помощью шаблона |
| SignatureRequestApi | Файлы запроса подписи | GET /signature_request/files/{signature_request_id} | Скачать файлы |
| SignatureRequestApi | SignatureRequestFilesAsDataUri | GET /signature_request/files_as_data_uri/{signature_request_id} | Загрузить файлы как Uri данных |
| SignatureRequestApi | ПодписьRequestFilesAsFileUrl | GET /signature_request/files_as_file_url/{signature_request_id} | Загрузить файлы как URL-адрес файла |
| SignatureRequestApi | Запрос подписиПолучить | ПОЛУЧИТЬ /signature_request/{signature_request_id} | Получить запрос на подпись |
| SignatureRequestApi | Список запросов подписи | ПОЛУЧИТЬ /signature_request/список | Получение списка запросов на подпись |
| SignatureRequestApi | ПодписьЗапросОсвободитьУдержание | POST /signature_request/release_hold/{signature_request_id} | Освободите запрос на подпись на удержании |
| SignatureRequestApi | ПодписьЗапросНапомнить | POST /signature_request/напомнить/{signature_request_id} | Отправить запрос напоминание |
| SignatureRequestApi | ПодписьЗапросУдалить | POST /signature_request/remove/{signature_request_id} | Удалить доступ к запросу на подпись |
| SignatureRequestApi | ПодписьЗапросОтправить | POST /signature_request/отправить | Отправить запрос на подпись |
| SignatureRequestApi | ПодписьRequestSendWithTemplate | POST /signature_request/send_with_template | Отправить с шаблоном |
| SignatureRequestApi | SignatureRequestUpdate | POST /signature_request/update/{signature_request_id} | Обновить запрос подписи |
| TeamApi | TeamAddMember | PUT /team/add_member | Добавить пользователя в команду |
| TeamApi | КомандаСоздать | POST /команда/создать | Создать команду |
| TeamApi | КомандаУдалить | УДАЛИТЬ /команда/уничтожить | Удалить команду |
| TeamApi | КомандаGet | ПОЛУЧИТЬ /команда | Получить команду |
| TeamApi | Информация о команде | ПОЛУЧИТЬ /команда/информация | Получить информацию о команде |
| TeamApi | TeamInvites | ПОЛУЧИТЕ /team/приглашения | Получение списка приглашений в команду |
| TeamApi | Члены команды | ПОЛУЧИТЬ /team/members/{team_id} | Список членов команды |
| TeamApi | КомандаRemoveMember | POST /команда/remove_member | Удалить пользователя из команды |
| TeamApi | КомандаПодгруппы | ПОЛУЧИТЬ /team/sub_teams/{team_id} | Список подкоманд |
| TeamApi | TeamUpdate | ПУТ /команда | Обновить команду |
| ШаблонАпи | Шаблонаддусер | POST /template/add_user/{template_id} | Добавить пользователя в шаблон |
| ШаблонАпи | ШаблонСоздать | POST /шаблон/создать | Создать шаблон |
| ШаблонАпи | ШаблонCreateEmbeddedDraft | POST /template/create_embedded_draft | Создать черновик встроенного шаблона |
| ШаблонАпи | Удаление шаблона | POST /template/delete/{template_id} | Удалить шаблон |
| ШаблонАпи | Файлы шаблонов | ПОЛУЧИТЬ /template/files/{template_id} | Получить файлы шаблонов |
| ШаблонАпи | Шаблонфилесасдатаури | ПОЛУЧИТЬ /template/files_as_data_uri/{template_id} | Получить файлы шаблонов как Uri данных |
| ШаблонАпи | Шаблонфилесасфилеурл | ПОЛУЧИТЬ /template/files_as_file_url/{template_id} | Получить файлы шаблонов как URL-адрес файла |
| ШаблонАпи | Получить шаблон | ПОЛУЧИТЬ /шаблон/{template_id} | Получить шаблон |
| ШаблонАпи | Список шаблонов | ПОЛУЧИТЬ /шаблон/список | Шаблоны списков |
| ШаблонАпи | ШаблонRemoveUser | POST /template/remove_user/{template_id} | Удалить пользователя из шаблона |
| ШаблонАпи | Файлы обновления шаблона | POST /template/update_files/{template_id} | Обновить файлы шаблонов |
| Невостребованный проектAPI | НевостребованныйЧерновикСоздать | POST /unclaimed_draft/создать | Создать невостребованный черновик |
| Невостребованный проектAPI | НевостребованныйDraftCreateEmbedded | POST /unclaimed_draft/create_embedded | Создать встроенный невостребованный черновик |
| Невостребованный проектAPI | НевостребованныйDraftCreateEmbeddedWithTemplate | POST /unclaimed_draft/create_embedded_with_template | Создать встроенный невостребованный черновик с помощью шаблона |
| Невостребованный проектAPI | Невостребованный черновикEditAndResend | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | Редактирование и повторная отправка невостребованного черновика |
Схемы аутентификации, определенные для API:
