DiadocAPI
Объект для создания контекста работы в Диадок
Свойства
- ApiClientId:
Строка, чтение/запись - ключ разработчика
- ServerUrl:
Строка, чтение/запись - URL сервера Диадок
- ProxyMode:
Строка, чтение/запись - режим использования прокси-сервера. Возможные значения
- ProxySettings:
ProxySettings , чтение - настройки прокси-сервера
- AutoLogonPolicy:
Строка, чтение/запись - настройка политики передачи авторизационных данных в запросах . Возможные значения
Добавлено в версии 5.32.0.
- VerifySslCertificate:
Булево, чтение/запись - флага проверки SSL сертиифкатов при выполнении запросов
Добавлено в версии 5.32.0.
Методы
Создание подключения |
Информация о сертификатах |
Утилиты |
|---|---|---|
Метод |
Рекомендуемая альтернатива |
Когда устарел |
Когда удалён |
|---|---|---|---|
- DiadocAPI.GetVersion()
Возвращает строку с версией используемой компоненты
- DiadocAPI.TestConnection()
Возвращает булевое значение успешности отправки запроса в Диадок, используя установленные параметры
- DiadocAPI.CreateConnectionByCertificate(Thumbprint[, Pin])
- Thumbprint:
Строка - отпечаток сертификата
- Pin:
Строка - пин-код или пароль от контейнера сертификата
Возвращает объект логического соединения, созданного по сертификату с указанным отпечатком. Поиск сертификата происходит в хранилище Личное пользователя и, если там сертиифкат не найден - в хранилище Личное машины. Если Pin не задан, то будет использоваться пин-код/пароль, запомненный в крипто-провайдере или пустая строка
- DiadocAPI.CreateConnectionByLogin(Login, Password)
- Login:
Строка - логин пользователя
- Password:
Строка - пароль пользователя
Возвращает объект логического соединения, созданного по логину и паролю
- DiadocAPI.CreateConnectionByCertificate2(Certificate)
- Certificate:
CertificateInfo - сертификат
Возвращает объект логического соединения, созданного при помощи указанного сертификата
Добавлено в версии 5.37.0.
- DiadocAPI.VerifyThatUserHasAccessToAnyBox(Thumbprint)
- Thumbprint:
Строка - отпечаток сертификата
Возвращает булевый признак, означающий есть ли у пользователя с указанным сертификатом доступ к какой-либо организации в Диадок
- DiadocAPI.GetPersonalCertificates(UserStore=True)
- UserStore:
Булево - флаг, определяющий хранилище сертификатов, где будет осуществлен поиск
Возвращает коллекцию сертификатов, установленных в подхранилище «Личное», хранилища определяемого флагом UserStore. Если флаг
True- хранилище пользователя(по-умолчанию),False- хранилище компьютера.
- DiadocAPI.GetPersonalCertificate(Thumbprint)
- Thumbprint:
Строка - oтпечаток сертификата
Возвращает сертификат с указанным отпечатком. Поиск происходит сначала в хранилище «Личные» пользователя, затем - машины
- DiadocAPI.GetFullVersion()
Возвращает строку с версией используемой компоненты в формате
[AddIn|COM] [x86|x64] <номер сборки>Добавлено в версии 5.29.4.
- DiadocAPI.TestConnection2()
Возвращает объект с результатами проверки соединения с сервером Диадока, используя установленные параметры
Добавлено в версии 5.26.3.
- DiadocAPI.UpdateProxySettings(Connection)
- Connection:
Connection - объект созданного подключения
Метод обновляет настройки прокси у переданного объекта подключения и у всех объектов, полученных с помощью него
Добавлено в версии 5.30.2.