Аннатура (независимый издатель) (предварительная версия)

Аннатура является ведущим австралийским решением eSigning с интегрированным поставщиком цифровой подписи. Этот соединитель помогает предприятиям создавать конверты и интегрировать рабочий процесс подписывания документов аннатуры с помощью API Аннатуры (версия 1).

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Д-р Адриан Колкуун (Strategik)
URL https://www.linkedin.com/in/adriancolquhoun/
Адрес электронной почты adrian@strategik.com.au
Метаданные соединителя
Publisher Д-р Адриан Колкуун (Strategik)
Веб-сайт https://annature.com.au
Политика конфиденциальности https://www.annature.com.au/privacy-policy
Категории Продуктивность

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Аннатур id струна Аннатур id True
Аннатур Ключ securestring Аннатур Ключ True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Конверт void

Отправка конверта
Отправка конверта

Отправка конверта
Получение всех вложений для поля

Получение вложений полей
Получение документов

Вывод списка всех документов для конверта
Получение конверта

Получение конверта
Получение конвертов

Вывод списка всех конвертов
Получение организации

Получение организации
Получение полей

Вывод списка всех полей
Получение получателя

Получение одного получателя, созданного для конверта с помощью свойства идентификатора, возвращенного в тексте ответа конверта
Получение поля

Получение поля
Получение учетных записей

Вывод списка всех учетных записей
Получение шаблона

Получение шаблона
Получение шаблонов

Вывод списка всех шаблонов
Создание конверта

Создание конверта
Создание конверта из шаблона

Использование шаблона
Удаление конверта

Удаление конверта

Конверт void

Идентификатор операции:
VoidEnvelope

Отправка конверта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 id True string

Идентификатор конверта

Отправка конверта

Идентификатор операции:
SendEnvelope

Отправка конверта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 id True string

Идентификатор конверта

Получение всех вложений для поля

Идентификатор операции:
GetFieldAttachments

Получение вложений полей

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelope_id True string

Идентификатор конверта
Идентификатор поля
 id True string

Идентификатор поля

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
 id string
Исходный текст
 original string
имя
 name string
type
 type string
size
 size integer
создано
 created string

Получение документов

Идентификатор операции:
GetDocuments

Вывод списка всех документов для конверта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelope_id True string

Идентификатор конверта
Длительность конечной точки
 endpoint_duration integer

Задает количество минут, для которых будут доступны исходные и главные конечные точки. Число может варьироваться от 1 до 10080 с значением по умолчанию 60

Возвращаемое значение

Имя Путь Тип Описание
array of object
Идентификатор
 id string

Идентификатор
Имя
 name string

Имя
pages
 pages integer
Исходный текст
 original string

Исходный текст
Мастер
 master string

Мастер
Создано
 created string

Создано

Получение конверта

Идентификатор операции:
GetEnvelope

Получение конверта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 id True string

Идентификатор конверта
Длительность конечной точки
 endpoint_duration integer

Задает количество минут, для которых будут доступны исходные и главные конечные точки. Число может варьироваться от 1 до 10080 с значением по умолчанию 60

Возвращаемое значение

Имя Путь Тип Описание
id
 id string

Идентификатор
имя
 name string

Имя
сообщение
 message string

Message
статус
 status string

Состояние
общие
 shared boolean

Shared
создано
 created string

Создано
посылать
 sent string

Sent
Аннулированы
 voided string

Аннулированный
Отказался
 declined string

Declined
завершено
 completed string

Завершено
master
 master string

Мастер
комбинированный
 combined string

Комбинированный
certificate
 certificate string

Certificate
account_id
 account_id string

Идентификатор учетной записи
group_id
 group_id string

Идентификатор группы
Получатели
 recipients array of object
Имя
 recipients.name string

Имя
Идентификатор электронной почты
 recipients.email string

Идентификатор электронной почты
мобильное устройство
 recipients.mobile string

мобильное устройство
Тип получателя
 recipients.type string

Тип получателя по умолчанию используется для подписывания, если он не указан.
Message
 recipients.message string

Message
Пароль
 recipients.password
Приглушенный?
 recipients.muted boolean

Это остановит Аннатуру от отправки любой корреспонденции получателю
Порядок подписывания
 recipients.order integer

Порядок подписывания
Конечная точка назначения после завершения конверта получателя
 recipients.redirects.session_completed string

Конечная точка назначения после завершения конверта получателя
Конечная точка назначения после того, как получатель отказался подписать конверт
 recipients.redirects.session_declined string

Конечная точка назначения после того, как получатель отказался подписать конверт
столбцов
 recipients.fields array of object
id
 recipients.fields.id string
recipient_id
 recipients.fields.recipient_id string
type
 recipients.fields.type string
page
 recipients.fields.page integer
x_coordinate
 recipients.fields.x_coordinate integer
y_coordinate
 recipients.fields.y_coordinate integer
Обязательно
 recipients.fields.required boolean

Обязательно
Read_only
 recipients.fields.read_only boolean

Read_only
Совместных
 recipients.fields.collaborative boolean

Совместных
Ширина
 recipients.fields.width integer
font_size
 recipients.fields.font_size integer
font_type
 recipients.fields.font_type string
создано
 recipients.fields.created string

Получение конвертов

Идентификатор операции:
GetEnvelopes

Вывод списка всех конвертов

Параметры

Имя Ключ Обязательно Тип Описание
Имя конверта
 name string

Фильтр точного соответствия в списке на основе свойства имени конверта
Состояние конверта
 status string

Фильтр точного соответствия в списке на основе состояния конверта
Имя получателя
 recipient string

Фильтр точного соответствия в списке на основе имени или свойства электронной почты получателя
Создано раньше
 created_before date

Возвращает результаты, в которых дата создания находится до заданного значения.
Создано после
 created_after date

Возвращает результаты, в которых дата создания после заданного значения
Завершено до
 completed_before date

Возвращает результаты, в которых дата завершения до заданного значения
Завершено после
 completed_after date

Возвращает результаты, в которых дата завершения после заданного значения

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
 id string

Идентификатор
имя
 name string

Имя
сообщение
 message string

Message
статус
 status string

Состояние
общие
 shared boolean

Shared
создано
 created string

Создано
посылать
 sent string

Sent
Аннулированы
 voided string

Аннулированный
Отказался
 declined string

Declined
завершено
 completed string

Завершено
комбинированный
 combined string

Комбинированный
master
 master string

Мастер
certificate
 certificate string

Certificate
account_id
 account_id string

Идентификатор учетной записи
group_id
 group_id string

Идентификатор группы
Получатели
 recipients array of object
Имя
 recipients.name string

Имя
Идентификатор электронной почты
 recipients.email string

Идентификатор электронной почты
мобильное устройство
 recipients.mobile string

мобильное устройство
Тип получателя
 recipients.type string

Тип получателя по умолчанию используется для подписывания, если он не указан.
Message
 recipients.message string

Message
Пароль
 recipients.password
Приглушенный?
 recipients.muted boolean

Это остановит Аннатуру от отправки любой корреспонденции получателю
Порядок подписывания
 recipients.order integer

Порядок подписывания
Конечная точка назначения после завершения конверта получателя
 recipients.redirects.session_completed string

Конечная точка назначения после завершения конверта получателя
Конечная точка назначения после того, как получатель отказался подписать конверт
 recipients.redirects.session_declined string

Конечная точка назначения после того, как получатель отказался подписать конверт
столбцов
 recipients.fields array of object
id
 recipients.fields.id string
recipient_id
 recipients.fields.recipient_id string
type
 recipients.fields.type string
page
 recipients.fields.page integer
x_coordinate
 recipients.fields.x_coordinate integer
y_coordinate
 recipients.fields.y_coordinate integer
Обязательно
 recipients.fields.required boolean

Обязательно
Read_only
 recipients.fields.read_only boolean

Read_only
Совместных
 recipients.fields.collaborative boolean

Совместных
Ширина
 recipients.fields.width integer
font_size
 recipients.fields.font_size integer
font_type
 recipients.fields.font_type string
создано
 recipients.fields.created string

Получение организации

Идентификатор операции:
GetOrganisation

Получение организации

Возвращаемое значение

Имя Путь Тип Описание
id
 id string

Идентификатор
имя
 name string

Имя
дело
 business string

Бизнес
электронная почта
 email string

Адрес электронной почты
число/номер
 number string

Number
address
 address string

Address
веб-сайт
 website string

Веб-сайт
logo
 logo string

Logo
цвет
 colour string

Цвет
создано
 created string

Создано

Получение полей

Идентификатор операции:
GetFields

Вывод списка всех полей

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelope_id True string

Идентификатор конверта

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
 id string
recipient_id
 recipient_id string
type
 type string
page
 page integer
привязка
 anchor string
x_coordinate
 x_coordinate integer
y_coordinate
 y_coordinate integer
Обязательно
 required boolean

Обязательно
Read_only
 read_only boolean

Read_only
Совместных
 collaborative boolean

Совместных
value
 value string
Проверено
 checked boolean

Проверено
height
 height integer
Ширина
 width integer
options
 options
font_size
 font_size integer
font_type
 font_type string
date_format
 date_format string
создано
 created string

Получение получателя

Идентификатор операции:
GetRecipient

Получение одного получателя, созданного для конверта с помощью свойства идентификатора, возвращенного в тексте ответа конверта

Параметры

Имя Ключ Обязательно Тип Описание
Recipient
 id True string

Идентификатор получателя

Возвращаемое значение

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор
имя
 name string

Имя
электронная почта
 email string

Адрес электронной почты
mobile
 mobile string

мобильное устройство
type
 type string

Тип
статус
 status string

Состояние
сообщение
 message string

Message
Пароль
 password

Пароль
Приглушенный
 muted boolean

Приглушенный
заказ
 order integer
declined_reason
 declined_reason string

Declined_reason
создано
 created string

Создано
посылать
 sent string

Sent
Отказался
 declined string

Declined
завершено
 completed string

Завершено
session_completed
 redirects.session_completed string

Session_completed
session_declined
 redirects.session_declined string

Session_declined

Получение поля

Идентификатор операции:
GetField

Получение поля

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 envelope_id True string

Идентификатор конверта
Идентификатор поля
 id True string

Идентификатор поля

Возвращаемое значение

Имя Путь Тип Описание
id
 id string

Идентификатор
recipient_id
 recipient_id string

Идентификатор получателя
type
 type string

Тип
page
 page integer
привязка
 anchor string

Anchor
x_coordinate
 x_coordinate integer
y_coordinate
 y_coordinate integer
Обязательно
 required boolean

Обязательно
Read_only
 read_only boolean

Read_only
Совместных
 collaborative boolean

Позволяет другим получателям в конверте изменять значения
value
 value string

Значение поля
Проверено
 checked boolean

Проверено
height
 height integer
Ширина
 width integer
options
 options
font_size
 font_size integer
font_type
 font_type string

Возможные значения — курьер и helvetica
date_format
 date_format string

Формат даты
создано
 created string

Создано

Получение учетных записей

Идентификатор операции:
GetAccounts

Вывод списка всех учетных записей

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
 id string
Имя
 name string

Имя
Адрес электронной почты
 email string

Адрес электронной почты
число/номер
 number string
timezone
 timezone string
роль
 role string
активный
 active boolean
group_id
 group_id string
создано
 created string
Проверить
 verified string

Получение шаблона

Идентификатор операции:
GetTemplate

Получение шаблона

Параметры

Имя Ключ Обязательно Тип Описание
ИД шаблона
 id True string

ИД шаблона

Возвращаемое значение

Имя Путь Тип Описание
id
 id string
имя
 name string
Shared
 shared boolean

Shared
envelope_name
 envelope_name string
envelope_message
 envelope_message string
Envelope_shared
 envelope_shared boolean

Envelope_shared
создано
 created string
account_id
 account_id string
group_id
 group_id string
Документы
 documents array of object
Идентификатор
 documents.id string

Идентификатор
Имя
 documents.name string

Имя
pages
 documents.pages integer
Исходный текст
 documents.original string

Исходный текст
Мастер
 documents.master string

Мастер
Создано
 documents.created string

Создано
roles
 roles array of object
Идентификатор
 roles.id string

Идентификатор
Имя
 roles.name string

Имя
Имя получателя
 roles.recipient_name string

Имя получателя
Электронная почта получателя
 roles.recipient_email string

Электронная почта получателя
Мобильный получатель
 roles.recipient_mobile string

Мобильный получатель
Тип получателя
 roles.recipient_type string

Тип получателя по умолчанию используется для подписывания, если он не указан.
Пароль
 roles.recipient_password string

Пароль
Порядок подписывания
 roles.order integer

Порядок подписывания
Конечная точка назначения после завершения конверта получателя
 roles.recipient_redirects.session_completed string

Конечная точка назначения после завершения конверта получателя
Конечная точка назначения после того, как получатель отказался подписать конверт
 roles.recipient_redirects.session_declined string

Конечная точка назначения после того, как получатель отказался подписать конверт

Получение шаблонов

Идентификатор операции:
GetTemplates

Вывод списка всех шаблонов

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 name string

Фильтр точного соответствия в списке на основе шаблонов
Создано раньше
 created_before date

Возвращает результаты, в которых дата создания находится до заданного значения.
Создано после
 created_after date

Возвращает результаты, в которых дата создания после заданного значения

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
 id string
имя
 name string
Shared
 shared boolean

Shared
envelope_name
 envelope_name string
envelope_message
 envelope_message string
Envelope_shared
 envelope_shared boolean

Envelope_shared
создано
 created string
account_id
 account_id string
group_id
 group_id string
Документы
 documents array of object
Идентификатор
 documents.id string

Идентификатор
Имя
 documents.name string

Имя
pages
 documents.pages integer
Исходный текст
 documents.original string

Исходный текст
Мастер
 documents.master string

Мастер
Создано
 documents.created string

Создано
roles
 roles array of object
Идентификатор
 roles.id string

Идентификатор
Имя
 roles.name string

Имя
Имя получателя
 roles.recipient_name string

Имя получателя
Электронная почта получателя
 roles.recipient_email string

Электронная почта получателя
Мобильный получатель
 roles.recipient_mobile string

Мобильный получатель
Тип получателя
 roles.recipient_type string

Тип получателя по умолчанию используется для подписывания, если он не указан.
Пароль
 roles.recipient_password string

Пароль
Порядок подписывания
 roles.order integer

Порядок подписывания
Конечная точка назначения после завершения конверта получателя
 roles.recipient_redirects.session_completed string

Конечная точка назначения после завершения конверта получателя
Конечная точка назначения после того, как получатель отказался подписать конверт
 roles.recipient_redirects.session_declined string

Конечная точка назначения после того, как получатель отказался подписать конверт

Создание конверта

Идентификатор операции:
CreateEnvelope

Создание конверта

Параметры

Имя Ключ Обязательно Тип Описание
Имя
 name True string

Имя конверта, отображаемое в теме сообщений электронной почты, отправляемых получателям, и при просмотре конверта
Message
 message string

Message
Shared
 shared boolean

Shared
Является черновиком
 draft boolean

Является черновиком
ID счета
 account_id True string

ID счета
Идентификатор группы
 group_id string

Идентификатор группы
Идентификатор группы
 id string

Идентификатор группы
Имя
 name string

Имя
Тип
 type string

Тип
Содержимое файла
 base byte

Содержимое файла
Имя
 name string

Имя
Идентификатор электронной почты
 email string

Идентификатор электронной почты
мобильное устройство
 mobile string

мобильное устройство
Тип получателя
 type string

Тип получателя по умолчанию используется для подписывания, если он не указан.
Message
 message string

Message
пароль
 password string
Приглушенный?
 muted boolean

Это остановит Аннатуру от отправки любой корреспонденции получателю
Порядок подписывания
 order integer

Порядок подписывания
Завершение сеанса
 session_completed string

Конечная точка назначения после завершения конверта получателя
Отклонение сеанса
 session_declined string

Конечная точка назначения после того, как получатель отказался подписать конверт
id
 id string
recipient_id
 recipient_id string
type
 type string

Тип поля
page
 page integer
x_coordinate
 x_coordinate integer
y_coordinate
 y_coordinate integer
Обязательно
 required boolean

Обязательно
Только для чтения
 read_only boolean

Только для чтения
Совместных
 collaborative boolean

Совместных
Ширина
 width integer
font_size
 font_size integer
font_type
 font_type string

Возможные значения — курьер и helvetica
создано
 created string

Возвращаемое значение

Имя Путь Тип Описание
id
 id string

Идентификатор
имя
 name string

Имя
сообщение
 message string

Message
статус
 status string

Состояние
Shared
 shared boolean

Shared
Создано
 created string

Создано
Отправлено
 sent string

Отправлено
Аннулированы
 voided
Отказался
 declined
завершено
 completed
Идентификатор учетной записи
 account_id string

Account_id
Идентификатор группы
 group_id string

Идентификатор группы
recipients
 recipients array of object
id
 recipients.id string
имя
 recipients.name string
электронная почта
 recipients.email string
mobile
 recipients.mobile string
type
 recipients.type string
статус
 recipients.status string
сообщение
 recipients.message string
Пароль
 recipients.password

Пароль
Приглушенный
 recipients.muted boolean

Приглушенный
заказ
 recipients.order integer
declined_reason
 recipients.declined_reason
создано
 recipients.created string
посылать
 recipients.sent string
Отказался
 recipients.declined
завершено
 recipients.completed
session_completed
 recipients.redirects.session_completed string
session_declined
 recipients.redirects.session_declined string

Создание конверта из шаблона

Идентификатор операции:
UseTemplate

Использование шаблона

Параметры

Имя Ключ Обязательно Тип Описание
ИД шаблона
 id True string

ИД шаблона
Имя
 name string

Имя конверта, отображаемое в теме сообщений электронной почты, отправляемых получателям, и при просмотре конверта
Является черновиком
 draft boolean

Является черновиком
Message
 message string

Message
Shared
 shared boolean

Shared
ID счета
 account_id True string

ID счета
Идентификатор группы
 group_id string

Идентификатор группы
Идентификатор группы
 id string

Идентификатор группы
Имя
 name string

Имя
Идентификатор группы
 type string

Идентификатор группы
Содержимое файла
 base byte

Содержимое файла
Идентификатор роли
 role_id string

Идентификатор роли
Имя
 name string

Имя
Идентификатор электронной почты
 email string

Идентификатор электронной почты
мобильное устройство
 mobile string

мобильное устройство
Проверка подлинности SMS
 sms_auth string

Проверка подлинности SMS
Тип получателя
 type string

Тип получателя по умолчанию используется для подписывания, если он не указан.
Message
 message string

Message
пароль
 password string
Приглушенный?
 muted boolean

Это остановит Аннатуру от отправки любой корреспонденции получателю
Порядок подписывания
 order integer

Порядок подписывания
Идентификатор поля (из шаблона)
 id True string

Идентификатор поля шаблона
Ценность
 value True string

Значение для этого поля
Конечная точка назначения после завершения конверта получателя
 session_completed string

Конечная точка назначения после завершения конверта получателя
Конечная точка назначения после того, как получатель отказался подписать конверт
 session_declined string

Конечная точка назначения после того, как получатель отказался подписать конверт

Возвращаемое значение

Имя Путь Тип Описание
id
 id string

Идентификатор
имя
 name string

Имя
сообщение
 message string

Message
общие
 shared boolean

Предоставляется ли общий доступ?
draft
 draft boolean
account_id
 account_id string

Идентификатор учетной записи
group_id
 group_id string

Идентификатор группы
Документы
 documents array of object
Идентификатор
 documents.id string

Идентификатор
Имя
 documents.name string

Имя
pages
 documents.pages integer
Исходный текст
 documents.original string

Исходный текст
Мастер
 documents.master string

Мастер
Создано
 documents.created string

Создано
recipients
 recipients array of object
role_id
 recipients.role_id string
имя
 recipients.name string
электронная почта
 recipients.email string
mobile
 recipients.mobile string
сообщение
 recipients.message string
пароль
 recipients.password boolean
приглушенный
 recipients.muted boolean
session_completed
 recipients.redirects.session_completed string
session_declined
 recipients.redirects.session_declined string

Удаление конверта

Идентификатор операции:
DeleteEnvelope

Удаление конверта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор конверта
 id True string

Идентификатор конверта

Триггеры

Триггер события — конверт и получатель

Триггеры, когда событие возникает при завершении конвертов или представлений получателей

Триггер события — конверт и получатель

Идентификатор операции:
OnDocumentEvent

Триггеры, когда событие возникает при завершении конвертов или представлений получателей

Возвращаемое значение

Тело
WebhookEventContent

Определения

WebhookEventContent

Имя Путь Тип Описание
событие
 event string
envelope_id
 envelope_id string
Аннулированы
 voided string
завершено
 completed string
master
 master string
certificate
 certificate string
посылать
 sent string
method
 method string
recipient_id
 recipient_id string
Просмотрели
 viewed string
Отказался
 declined string
declined_reason
 declined_reason string
ошибка
 failed string
Диагноз
 diagnosis string