Перейти к основному содержимому

API Печатных форм

Список шаблонов ПФ​

GET /api/templates

Ответ:

[
        {
            "id": 76, // ID печатной формы
            "title": "", // Название печатной формы
            "scopes": {
                "lead": true,
                "client": true,
                "contract": true,
                "loanApp": false,
                "signatures": false,
                "depositContract": false,
                "shareContract": false,
                "fundTransactions": false,
                "groupConvention": false,
                "collateralLine": false,
                "committee": false
            },
            "createdAt": "2020-12-29T16:40:19+00:00",
            "updatedAt": "2022-02-18T08:50:23+00:00"
        }
]

Генерация ПФ​

POST /api/documents/generate

В заголовках запроса необходимо отправить

  • bsauth - токен авторизации BrainySoft
  • customer-key - Кодовое название организации

Возможные параметры

  • sync=false (По умолчанию: true) - Синхронная генерация ПФ

Тело запроса:

{
    "templateId": 111, //ID печатной формы
    "lead": 1, // ID лида
	"client": 2, // ID клиента
	"loanapp": 3, // ID заявки
	"contract": 4, // ID контракта
	"collateralline": 5 // ID кредитной линии
}

Ответ:

{
    "status": "ok",
    "timestamp": 1617623638000,
    "data": {
        "uuid": "идентификатор генерации",
        "status": "статус генерации",
        "selector": "Адрес страницы фыбора варианта скачивания ПФ",
        "original": {
            "download": "Ссылка на скачивание формы в формате docx",
            "preview": null
        },
        "pdf": {
            "download": "Ссылка на скачивание формы в формате pdf",
            "preview": "Ссылка на просмотр формы в браузере"
        }
    }
}

Генерация ПФ с дополнительными переменными​

POST /api/documents/generate/data-raw

В заголовках запроса необходимо отправить

  • bsauth - токен авторизации BrainySoft
  • customer-key - Кодовое название организации

Данный метод работает только в синхронном режиме

Тело запроса:

{
    "templateId": 111, //ID печатной формы
    "lead": 1, // ID лида
    "client": 2, // ID клиента
    "loanapp": 3, // ID заявки
    "contract": 4, // ID контракта
    "collateralline": 5 // ID кредитной линии
    "variables": { // Объект с дополнытельными переменными
        "smsCode": "" // переменную ${smsCode} можно будет использовать в ПФ
    }
}

Ответ:

{
    "status": "ok",
    "timestamp": 1617623638000,
    "data": {
        "selector": "Адрес страницы фыбора варианта скачивания ПФ",
        "original": {
            "download": "Ссылка на скачивание формы в формате docx",
            "preview": null
        },
        "pdf": {
            "download": "Ссылка на скачивание формы в формате pdf",
            "preview": "Ссылка на просмотр формы в браузере"
        }
    }
}

Статус генерации​

GET /api/documents/{uuid}

В заголовках запроса необходимо отправить

  • bsauth - токен авторизации BrainySoft
  • customer-key - Кодовое название организации

Ответ

{
    "status": "ok",
    "timestamp": 1617623638000,
    "data": {
        "uuid": "идентификатор генерации",
        "status": "статус генерации",
        "selector": "Адрес страницы фыбора варианта скачивания ПФ",
        "original": {
            "download": "Ссылка на скачивание формы в формате docx",
            "preview": null
        },
        "pdf": {
            "download": "Ссылка на скачивание формы в формате pdf",
            "preview": "Ссылка на просмотр формы в браузере"
        }
    }
}

Возможные варианты статуса генерации

waiting - В очереди

preparing - Сбор данных

generating - Формирование ПФ

error - Ошибка при формировании

done - Печатная форма успешно сформирована