Перейти к содержанию

API

1. Авторизация

Запрос:

POST https://app.kombinator.ru/api/v1/account/login
Body: application/json
{ 
    "email": "<логин>",
    "password": "<пароль>"
}

Ответ:

200OK - успешная авторизация, устанавливается cookie 
400BadRequest - неуспешная авторизация
Body: application/json
{
   "error": "<строка с кодом ошибки>"
}

Все последующие запросы могут выполняться только после прохождения авторизации.

2. Выход из аккаунта

Запрос:

POST https://app.kombinator.ru/api/v1/account/logout

Ответ: 

200OK

3. Создание документа с предварительно заполненными данными, с сохранением в файловой системе Комбинатора

Запрос:

POST https://app.kombinator.ru/api/v2/templates/createdocument
Body: application/json
{
   "templateId": <id шаблона>,
   "data": 
     {
        "<наименование простого поля>": "<значение поля>",
         "<наименование составного поля>"
            {
              "<наименование вложенного поля>": "<значение вложенного поля>", …
            } 
             …
      }
}

Ответ:

200OK – успешное выполнение
Body: application/json
{
   "documentId": <id созданного документа>,
   "fillDocumentLink": <URL для открытия документа в Комбинаторе>
}
400BadRequest – шаблон с указанным id не найден
Body: application/json
{
"error": "<строка с кодом ошибки>"
}

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

Если в разделе «data» перечислены не все поля шаблона, оставшиеся поля будут иметь значения по умолчанию.

4. Создание документа с предварительно заполненными данными, без сохранения

Запрос:

POST https://app.kombinator.ru/api/v2/templates/generatedocument
Body: application/json
{
   "templateId": <id шаблона>,
   "data": 
      {
        "<наименование простого поля>": "<значение поля>",
        "<наименование составного поля>"
            {
              "<наименование вложенного поля>": "<значение вложенного поля>",  
              …
            }
            …
      },
    "format": <"docx" или "pdf">
}

Ответ:

200OK – успешное выполнение
Body: application/vnd.openxmlformats-officedocument.wordprocessingml.document 
или application/pdf (в зависимости от запрошенного формата)
400BadRequest – шаблон с указанным id не найден
Body: application/json
{
  "error": "<строка с кодом ошибки>"
}

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

Если в разделе «data» перечислены не все поля шаблона, оставшиеся поля будут иметь значения по умолчанию.

5. Загрузка заполненного документа из Комбинатора

Запрос:

GET https://app.kombinator.ru/api/v1/documents/render?documentid=<id 
документа>&rendertype=<"docx" или "pdf">

Ответ:

200OK – успешное выполнение
Body: application/vnd.openxmlformats-officedocument.wordprocessingml.document 
или application/pdf (в зависимости от запрошенного формата)
400BadRequest – документ с указанным id не найден
Body: application/json
{
  "error": "<строка с кодом ошибки>"
}