Центр поддержкиИнтеграции

Для: Администраторы

Отправляйте электронные подписи и считывайте подписи с помощью центрального ключа.

Создайте электронную подпись для дела на основе шаблона, выберите, кто подпишет каждое поле, опубликуйте документ для подписания и загрузите заблокированную копию после того, как все подпишут.

В этой статье9 разделов

Прежде чем начать

На этой странице рассказывается о процессе отправки данных. Электронные подписиЭлектронная подпись Документ, отправленный на электронную подпись и подписанный в браузере. И после этого необходимо добавить к своим подписям ключ хаба. Пути находятся в состоянии… https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Звонки

ВызовЧто это делает
GET /signs/templatesСписок ваших шаблонов электронной подписи
POST /signsСоздается электронная версия документа, которая пока не опубликована.
PUT /signs/<sign_id>/schemaВыбирается человек, который будет подписывать каждое поле.
PUT /signs/<sign_id>Перед публикацией необходимо изменять название, дату выпуска или информацию о возможности получения напоминаний.
PUT /signs/<sign_id>/publishОпубликувается это произведение; затем оно отправляется своим подписчикам.
GET /signs?filter=allПеречисление электронных документов по данному делу.
GET /signs/<sign_id>Читает один электронный документ, определяет его статус.
DELETE /signs/<sign_id>Удалите его вместе с всеми его подписами.
GET /signs/<sign_id>/responsesУказывает его сигнатуры.
GET /signs/<sign_id>/responses/<response_id>Читает один подпис.

Электронный документ генерируется поэтапно: сначала создается сам документ, затем проверяется, кто будет подписывать каждое поле документа. После этого документ публикуется. До момента публикации подписчики не видят документа, и никому об этом не сообщается. Как только документ становится доступным для чтения, ничего с ним не может быть изменено.

Создание электронной подписи

GET /signs/templates Перечисляет все опубликованные ваши электронные документы. ШаблоныШаблон Многоразовая запись в ленте новостей, форма, электронная подпись, заметка или задание, хранящиеся в библиотеке и копируемые на витрины., Старшие по возрасту первыми, каждый из них… asset_id, title, description, due_mins Сколько минут прошло с момента отправки сообщения? notifications, и role_field_participants, Роли, которые отображаются на каждой из полей.

POST /signs принимает следующие значения:

ПолеЧто это делаетНеобходимыйПо умолчанию
nameНазвание электронного документа: буквы, цифры, пробелы и символ & ' - _ ( ) . /. Нет запятых или точек.Да.—
duration{"due_date": "2026-10-09T17:00:00-04:00"}, с учетом зоны времени. Электронные документы не могут повторяться: правило повторения отклоняется.Да.—
template{"owner": "host", "template_id": "<asset_id>"} Использовать документ и стороны, упомянутые в шаблоне.Нет.Ничего.
descriptionПримечание, помещаемое вместе с электронной версией документа.Нет.Шаблоны
notificationsНапоминания: {"names": ["days"], "values": [-1440]}. Каждое значение указывает количество минут до наступления срока выполнения задачи.Нет.Шаблон… или ничего.
instant_notifyfalse Не отправлять никаких запросов во время публикации; достаточно использовать только напоминания.Нет.Шаблоны, или true
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

Это решает проблему с 201, используя значение sign_id. Документ, соответствующий шаблону, копируется в фоновом режиме: необходимо прочитать электронный документ до тех пор, пока в нем не исчезнут все элементы типа copying.

Если вы хотите отправить свой собственный PDF-файл, создайте электронную подпись без использования символа template. Затем загрузите PDF-файл в систему и ждите, пока он будет готов к использованию. После этого можно назначить соответствующие поля для данного документа. Подробнее смотрите раздел Загрузка и приложение файлов с помощью хабового ключа.

Выбор того, кто подпишет

Из шаблона каждое поле соответствует людям, которые будут выполнять свои обязанности при создании электронного документа. Поэтому сначала нужно добавить клиента в список участников процесса. field_participants в электронном документе показывает результат: имя каждого поля, а также идентификационные номера пользователей, которые подписывают этот документ.

Чтобы изменить его, отправьте весь карта в адрес PUT /signs/<sign_id>/schema:

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • Каждый человек, имеющий право на участие в расследовании, должен быть заинтересованным в этом деле. Виртуальный помощник не может подписывать документы.
  • Названия полей – это те названия, которые имеются в документе.
  • Эта карта заменяет старую карту: поля, которые не указаны на этой карте, не имеют никаких обозначений.

Издательский

PUT /signs/<sign_id>/publish не принимает никакого значения и возвращает значение 200. По крайней мере, один из полей должен иметь значение “сигнализатор”. Поле без значения остается пустым.

  • Каждому подписавшемуся на рассылку приходит электронное письмо с просьбой подписать документ. Если у человека нет аккаунта в электронной почте, ему также отправляется сообщение по текстовому сообщению. Это происходит немедленно, если только… instant_notify есть false. Это видно на их… Что нужно сделатьДелать Список дел, ожидающих вас, таких как заполнение форм, подписание документов или подтверждение событий. И также в уведомлениях на их портале.
  • Повторные напоминания отправляются каждый раз. notifications Они все еще опережают остальных, пока не подпишут контракт.
  • Кто-то, находящийся вдали от этого места, останавливается и берет его в руки.

После подписания

Электронные документы/свидетельства status читает completed Как только все подпишут документ, и… completed_on Указывается время, в UTC. Например: 2026-10-06T21:42:10.123456+00:00. До сих пор у него нет ни того, ни другого. responses Каждый подписавший документ должен указать свое имя на нем. response_id.

GET /signs/<sign_id>/responses На одной странице указаны подписи всех участников; самые старые подписи расположены в начале списка. Каждый участник имеет свою подпись. user_id, Когда они подписали документы, они заполнили соответствующие поля. response.formFieldValues, Подписать под этим документом. response.annotations, С любой изображением подписи. response.attachments, И также адрес IP, который они получили в качестве подписи. response.ip.

Сотрудникам, занимающимся этим делом, каждый раз сообщают о времени подписания документов. Также им сообщается о времени готовности подписанных копий документов. Все лица, которые подписывают документы, также получают уведомление о времени его готовности.

Заблокированная копия

Как только все подписались, создается запечатанная копия документа, на которой указаны все подписи. Информация о документе также указана в соответствующем разделе. media.schemas.items Получения выгоды flat, Путь к файлу-копии. flat_status, SUCCEEDED или FAILED. Можно скачать его в любом формате. Подробнее смотрите здесь. Загрузите и приложите файлы, имеющие ключ hub..

Составление списка и удаление

GET /signs Нуждается filter: all Список содержит информацию обо всех электронных документах, связанных с данной дело, включая неопубликованные документы. Самые свежие документы расположены в начале списка. self Это список того, что отправил виртуальный помощник – с помощью любого из ваших ключей или с помощью автоматических процедур. completed и uncompleted Указывайте имена собственники звонящих людей. Таким образом, поле для ввода имен будет всегда пустым. Необходимо проверить каждый электронный подписной документ. status и completed_on Вместо этого.

DELETE /signs/<sign_id> может удалить любой электронный документ в любое время, включая все подписи, и отменить его от списка дел всех участников. Никому не сообщается об этом.

Если звонок отклонен

СтатусmessageПочему
400SchemaFieldsExceptionВ данном поле отсутствуют или имеются некорректные значения: например, использование запятых в местах name, повторение правил, либо наличие подписчика, который не участвует в этой ситуации. В месте errors указано название этого поля.
400SchemaFieldsException, при условии, что ItemCopyNotAllowedException находится в пределах templateШаблон еще не опубликован, он не доступен для использования роботами, или его файлы все еще обрабатываются.
403PublishAlreadyPublishedExceptionЭто уже опубликовано, поэтому его нельзя изменить.
403PublishAlreadyAnsweredExceptionКто-то уже подписал его.
403PublishParticipantsMissingExceptionНет такого поля, на котором есть какой-либо сигнал/знак.
403PublishMediaMissingExceptionПока у него нет никаких документов.
403PublishMediaNotReadyExceptionЕго документ все еще находится в процессе копирования или преобразования.
403PublishMediaFailedExceptionЕго документ не смог быть преобразован в нужном формате.
403PublishDocumentUnreadableExceptionЕго документ не может быть прочитан. Необходимо удалить электронную подпись и создать документ заново.
403PublishDueTimePassedExceptionСрок его использования уже истек.
403BotNotAllowedExceptionКто-то попытался подписать документ или стереть подпись другого человека.
403CaseClosedExceptionДело закрыто.
404ItemNotFoundExceptionЭлектронная подпись или печать не существует.

Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.

Статьи по теме

Разберитесь, что может делать API.Узнайте, к чему могут иметь доступ ключ управления и ключ концентратора, почему каждый ключ действует как виртуальный помощник и где находится полный технический паспорт.ИнтеграцииОтправляйте формы и читайте ответы с помощью центрального ключа.Создайте форму по делу на основе шаблона, опубликуйте ее для тех, кто должен ее заполнить, и ознакомьтесь с их ответами.ИнтеграцииЗагружайте и прикрепляйте файлы с помощью ключа хаба.Получите адрес для загрузки, загрузите файл, прикрепите его к сообщению, заметке, заданию, форме или электронной подписи, а также скачайте файлы дела.ИнтеграцииОбработка ошибок и кодов состояния API.Прочитайте текст ошибки, что означают коды 400, 401, 403, 404, 500 и 503, и почему элемент, который ваш ключ не видит, выдает ошибку 404.Интеграции