Публичный API

GET /api/users/me

Возвращает данные пользователя по токену.

Успешный ответ: 200 OK

{ "id": 1, "username": "userName", "email": "user@example.com" }

Частые ошибки

401 Unauthorized при отсутствующем или некорректном bearer token.

GET /api/sites/get

Возвращает сайты, доступные API-токену.

Успешный ответ: 200 OK

{ "_embedded": { "siteDtoList": [ { "id": 43429, "name": "Main site" } ] }, "page": { "size": 10, "totalElements": 1, "totalPages": 1, "number": 0 } }

GET /api/forms/get

Возвращает формы, доступные API-токену.

Успешный ответ: 200 OK

{ "_embedded": { "formDTOList": [ { "id": 21748, "name": "Lead form", "formId": "form_xxxxx", "status": 1 } ] }, "page": { "size": 10, "totalElements": 1, "totalPages": 1, "number": 0 } }

GET /api/forms/{id}/fields

Возвращает поля формы и варианты ответов для option-полей.

Успешный ответ: 200 OK

[ { "id": 63309, "name": "fire_question_1", "typeId": "RADIO", "required": 1, "label": "Что необходимо сделать в первую очередь при обнаружении пожара?", "orderField": 1, "answerEvaluationEnabled": true, "options": [ { "key": "answer-1", "value": "Позвонить 101 или 112", "isCorrect": true, "comment": "Первым делом нужно вызвать пожарных." }, { "key": "answer-2", "value": "Размотать пожарный гидрант", "isCorrect": false, "comment": "Сначала нужно сообщить о пожаре." } ] } ]

Поля answerEvaluationEnabled, options[].isCorrect и options[].comment возвращаются для RADIO, если для поля настроена оценка правильных ответов.

Частые ошибки

404 Not Found или Forms not found, если форма не найдена или недоступна токену.

GET /api/leads/get

Возвращает заявки, доступные API-токену.

Успешный ответ: 200 OK

{ "_embedded": { "leadDataDTOList": [ { "id": 405910, "date": 1715060000, "formId": 21748, "status": 1, "formName": "Lead form", "fields": { "name": "Ivan", "fire_question_1": "Позвонить 101 или 112" }, "correctAnswersResult": { "correctAnswersCount": 1, "wrongAnswersCount": 0, "allAnswersCount": 1, "correctAnswersPercent": 100 } } ] }, "page": { "size": 10, "totalElements": 1, "totalPages": 1, "number": 0 } }

GET /api/leads/get/{siteId}/{formId}

Возвращает заявки конкретной формы на конкретном сайте.

Успешный ответ: 200 OK

Формат ответа такой же, как у GET /api/leads/get.

Частые ошибки

404 Site not found, 404 Form not found.

GET /api/leads/get/data/{leadId}

Возвращает детальные данные одной заявки.

Успешный ответ: 200 OK

{ "id": 405910, "date": 1715060000, "formId": 21748, "status": 1, "formName": "Lead form", "fields": { "name": "Ivan", "fire_question_1": "Позвонить 101 или 112", "file_field": [ "https://uapi.qform.io/api/file/get/123" ] }, "fileInfo": { "123": { "fileSize": 102400, "fileName": "file.pdf" } }, "leadInfo": { "referer_host": "example.com", "referer_path": "/page", "utm_source": "ads" }, "userInfo": { "yandex_client_id": "12345", "google_client_id": null }, "comments": [], "correctAnswersResult": { "correctAnswersCount": 1, "wrongAnswersCount": 0, "allAnswersCount": 1, "correctAnswersPercent": 100 }, "answerMeta": { "fire_question_1": { "answerType": "correct", "comment": "Первым делом нужно вызвать пожарных.", "correctAnswer": "Позвонить 101 или 112" } } }

fields остается картой фактических ответов. Метаданные правильных ответов находятся рядом в correctAnswersResult и answerMeta.

Частые ошибки

404 Lead or form not found, 404 Site not found.

POST /api/leads/update-status/

Обновляет статус заявки.

Content-Type: application/x-www-form-urlencoded; charset=utf-8

Успешный ответ: 200 OK

Возвращает детальную структуру заявки, как GET /api/leads/get/data/{leadId}.

POST /api/leads/{id}/add

Создает заявку в форме.

Content-Type: application/x-www-form-urlencoded

Успешный ответ: 201 Created

{ "id": 405910 }

Частые ошибки

422 Field 'data' contains invalid JSON, 422 Field '...' is invalid, 400 Validation failed.

POST /api/personal/{id}/add

Создает одну или несколько персональных ссылок и сохраняет prefill-данные.

Content-Type: application/x-www-form-urlencoded

Успешный ответ для одной ссылки: 201 Created

{ "id": 10, "name": "Personal link name", "personalLink": "https://.../token" }

Успешный ответ для нескольких ссылок: 201 Created

{ "items": [ { "id": 10, "name": "Personal link name 1", "personalLink": "https://.../token-1" }, { "id": 11, "name": "Personal link name 2", "personalLink": "https://.../token-2" } ] }

Частые ошибки

422 Invalid PersonalLinkDTO, 422 Field link_count must be between 1 and 100, 422 Error creating personal link.

GET /api/personal/get/{siteId}/{formId}

Возвращает персональные ссылки формы.

Успешный ответ: 200 OK

{ "_embedded": { "personalLinkDTOList": [ { "id": 10, "name": "Personal link name", "isActive": true, "isMulti": false, "status": 0, "url": "token" } ] }, "page": { "size": 10, "totalElements": 1, "totalPages": 1, "number": 0 } }

POST /api/file/upload

Загружает файл во временную директорию temporary/.... Затем возвращенный payload используется в data при создании заявки или персональной ссылки.

Content-Type: multipart/form-data

Успешный ответ: 200 OK

{ "file_id": "uuid-file-id", "filename": "file.pdf", "objectKey": "temporary/uuid_file.pdf" }

Частые ошибки

400 Content-Type is not supported, 404 Form not found, 422 Field is not file, ошибки размера или типа файла.

GET /api/file/get/{id}

Скачивает файл, привязанный к записи qform_lead_data.

Успешный ответ: 200 OK

Возвращает бинарный поток с заголовками Content-Type: application/octet-stream и Content-Disposition: attachment.

Частые ошибки

404 File not found, 404 Lead or form not found, 404 Site not found.