Шаги для интеграции вашего проекта
Регистрация
Регистрация аккаунта разработчика на https://dashboard.sigmadoc.ru. Для регистрации достаточно указать email.
Оплата тарифа
Выберите срок оплаты тарифа. Для оплаты можно использовать как банковские карты, выпущенные в РФ, так и зарубежные.
Создание схемы базы данных
Вам нужно указать поля, которые будут браться из вашей базы данных и вставляться в договор при генерации. Поля всегда имеют строковый тип. Если вам нужно передавать числа, денежные суммы, даты и т. п., заранее преобразуйте их в нужный формат.
Если требуется более сложная вставка, то для этого используются внешние пункты договора, для которых текст целиком формируется на вашей стороне. При этом в конкретном договоре внешнего пункта может не быть, это нормальная ситуация, нумерация пунктов в таком случае не сломается.
Для создания схемы вам нужно использовать API-метод POST schemas/create.
Если требуется более сложная вставка, то для этого используются внешние пункты договора, для которых текст целиком формируется на вашей стороне. При этом в конкретном договоре внешнего пункта может не быть, это нормальная ситуация, нумерация пунктов в таком случае не сломается.
Для создания схемы вам нужно использовать API-метод POST schemas/create.
Создание шаблона
Чтобы создать шаблон договора в соответствии со схемой, следует создать шаблон через API-метод POST templates/create, запомнить Id созданного шаблона.
Затем создать токен редактирования через API-метод POST /api/v1/templates/{id}/tokens/create, где {id} соответствует ранее созданному шаблону.
После этого отредактировать шаблон в интерактивном редакторе можно по ссылке:
https://app.sigmadoc.ru/edit/{token}
где {token} соответствует ранее созданному ключу редактирования. Обратите внимание, что токен редактирования одноразовый. Для повторного редактирования вам нужно будет создать новый ключ.
Обратите внимание, что для того, чтобы пользователь после сохранения вернулся в ваше приложение, вам рекомендуется при создании токена редактирования, указать params: { "returnUrl": "<link to return>"}.
Затем создать токен редактирования через API-метод POST /api/v1/templates/{id}/tokens/create, где {id} соответствует ранее созданному шаблону.
После этого отредактировать шаблон в интерактивном редакторе можно по ссылке:
https://app.sigmadoc.ru/edit/{token}
где {token} соответствует ранее созданному ключу редактирования. Обратите внимание, что токен редактирования одноразовый. Для повторного редактирования вам нужно будет создать новый ключ.
Обратите внимание, что для того, чтобы пользователь после сохранения вернулся в ваше приложение, вам рекомендуется при создании токена редактирования, указать params: { "returnUrl": "<link to return>"}.
Генерация итогового документа
Для того, чтобы сгенерировать итоговый договор, следует использовать API-метод POST generator. Ему в теле запроса передаём id шаблона, а также текстовое содержимое полей и внешних пунктов.
Если какое-то поле есть в схеме, то передать его нужно обязательно. Внешние пункты же не обязательны, их можно пропустить, тогда они будут исключаться из генерируемого договора.
В качестве формата можно выбрать PDF или DOCX (Mircosoft Word).
Если какое-то поле есть в схеме, то передать его нужно обязательно. Внешние пункты же не обязательны, их можно пропустить, тогда они будут исключаться из генерируемого договора.
В качестве формата можно выбрать PDF или DOCX (Mircosoft Word).
