...
Возможны 2 варианта аутентификации
user_token
- строковый ключ пользователя (access token, apikey) можно узнать у администратора.jwt cookie полученная при авторизации в UI на странице
/login
либо через API вызов/api/ext/v2/login
user_token
- строковый ключ пользователя (access token, apikey) можно узнать у администратора.
При использовании user_token
может быть передан несколькими способами:
...
Code Block |
---|
response http code - 400 response content type - json response json.error === 'invalid_excel' response json.message === "Неизвестный формат файла" Текст ошибки пользователю: "Некорректный XLS файл" response http code - 400 response content type - json response json.error === 'invalid_excel' response json.message === "Файл должен содержать обязательные колонки 'наименование','ответ' и 'вопрос 1'" Текст ошибки пользователю: "Файл должен содержать обязательные колонки 'наименование','ответ' и 'вопрос 1'" response http code - 400 response content type - json response json.error === 'similar_paraphrase' Текст ошибки пользователю: `Схожая формулировка "${json.similar_paraphrase}" (${json.similar_paraphrase_id}) уже существует в документе ${json.similar_document_id} БЗ ${json.similar_service_id}` response http code - 400 response content type - json response json.error === 'similar_document' Текст ошибки пользователю: `Схожий документ уже существует ${json.similar_document_id} в БЗ ${json.similar_service_id} (формулировка "${json.similar_paraphrase}" (${json.similar_paraphrase_id}))` response http code - 400 response content type - json response json.error === 'invalid_parameter' response json.message === "invalid snapshot format - not zipfile" Текст ошибки пользователю: "Неизвестный формат файла" response http code - 400 response content type - json response json.error === 'invalid_parameter' Текст ошибки пользователю: "Некорректный запрос API БЗ" response http code - 404 response content type - json response json.error === 'not_found' Текст ошибки пользователю: "Ресурс не найден" response http code - 403 response content type - json response json.error === 'forbidden' Текст ошибки пользователю: "Недостаточно прав для доступа: (`json.message`)" response http code - 413 response content type - pain text текст содержит "Request Entity Too Large" Текст ошибки пользователю: "Размер файла превышает максимально допустимое значение" (Превышен Лимит на уровне nginx-router) response http code - 500 response content type - json response json.message содержит текст "Request Entity Too Large" Текст ошибки пользователю: "Размер файла превышает максимально допустимое значение" (Превышен Лимит на уровне backend API БЗ) response http code - 403 response content type - json response json.error === 'services_quota_exceeded' Текст ошибки пользователю: `Превышена квота на количество БЗ` response http code - 403 response content type - json response json.error === 'documents_quota_exceeded' Текст ошибки пользователю: `Превышена квота на количество документов в БЗ` response http code - 403 response content type - json response json.error === 'paraphrases_quota_exceeded' Текст ошибки пользователю: `Превышена квота на количество формулировок в документах БЗ` response http code - 403 response content type - json response json.error === 'resource_quota_exceeded' Текст ошибки пользователю: `Превышена квота на ресурсы БЗ (${json.message})` response http code - 403 response content type - json response json.error === 'requests_quota_exceeded' Текст ошибки пользователю: `Превышена квота на частоту обращений в API БЗ (${json.message})` response http code - 500 response content type - json response json.error === 'internal_error' Текст ошибки пользователю: `Внутренняя'Внутренняя ошибка: (${json.message})`' (Unhandled exception at backend) |
...
Подробнее примеры использования см вызовы методов /query и /click во вложении в демо скипте test_winnie_pooh.py
Пример использования batch query API
Примеры
Тривиальный пример жизненного цикла см скрипт test_winnie_pooh.py во вложении выше на этой странице .
...