Интеграция в вашу информационную систему функционала проверки оригинальности текстовых документов от компании «Антиплагиат» позволит вам использовать первый и лучший российский сервис поиска заимствований в рамках собственной бизнес-логики. Это означает, что поиск заимствований можно встроить именно туда, где он необходим, вызвать, когда это требуется именно вам, проверять только необходимые тексты и показывать результаты так, как того требует логика вашей информационной системы. На данном сайте размещены описания методов и структур данных для работы с API, ссылки на примеры использования и дополнительные информационные материалы.
Данные для тестового подключения:
WSDL: https://api.antiplagiat.ru:4959/apiCorp/testapi?wsdl
Логин: testa.nosp@m.pi@a.nosp@m.ntipl.nosp@m.agia.nosp@m.t.ru
Пароль: testapi
Предупреждаем вас, что данный аккаунт находится в публичном доступе для тестовых целей, поэтому документы, загруженные в данный аккаунт, доступны другим пользователям, и мы не несем ответственность за их распространение.
Проверка ведется по собственной коллекции (идентификатор: testapi), русской и английской Википедии образца 2019 года (идентификатор: wikipedia). На проверку рекомендуется отправлять текстовые документы объемом не менее 200-500 символов. Чтобы совпадения были обнаружены, рекомендуем брать тексты статей из Википедии, созданных не позднее 2019 года.
Мы оставляем за собой право в любой момент очистить данную коллекцию от документов, поэтому не стоит ожидать, что ссылка на ваш документ или его идентификатор будут валидны долгое время.
Требования к интеграции
Интеграция проверок на заимствования системой Антиплагиат через API в вашу информационную систему (ИС) должна соответствовать следующим требованиям:
- В ИС должна быть форма для ввода данных подключения к API, которую должен заполнять администратор ИС. Набор полей для данной формы:
- Пользователям вашей ИС помимо цифровых результатов проверки (проценты оригинальности, совпадения, цитирования и самоцитирования) должна быть доступна возможность:
- Рядом с цифровыми результатами проверки при наличии возможности перехода на редактируемый отчет, должна быть реализована кнопка "Обновить результаты", инициирующая получение обновленных результатов после редактирования отчета.
- Для подозрительных документов в интерфейсе ИС должен выводится символ подозрительности.
- Проверка на заимствования должна быть асинхронна для пользователей ИС. Пользователь должен получить результат проверки документа на заимствование (при последующем входе в личный кабинет в ИС), даже если он закроет страницу браузера или форму проверки документа во время проверки.
- После загрузки документа пользователю в ИС должно быть видно текущую фазу работы с документом: документ загружен, документ проверяется, произошла ошибка при проверке, документ успешно проверен.
- На проверку отправляются только документы поддерживаемых форматов (поле FileType). Для других форматов должна выводиться соответствующая ошибка без отправки запроса на проверку.
- Документ не должен автоматически загружаться или отправляться на проверку повторно, если его загрузка или проверка завершилась с ошибкой. Для таких документов должен выводиться соответствующий статус и должна быть возможность запустить проверку вручную.
- Пользователям ИС может быть доступна возможность добавления документов в индекс согласно настройкам ИС. Добавление документов в индекс должно быть доступно администратору ИС или автоматически выполнятся в рамках жизненного цикла документов.
- При загрузке/проверке документа может возникнуть ошибка (поле FailDetails). Для пользователей должно выводиться корректное отображение подобных ошибок.
- Интеграция с системой Антиплагиат должна передавать идентификатор пользователя в ИС (поле ExternalUserId). Данный идентификатор должен быть строкой не длиннее 40 знаков. Например: целое число; фамилия+номер студбилета; GUID для конкретного пользователя; email; md5-хэш email и т.п. Данный идентификатор используется для обнаружения утечек учетных данных пользователей в ИС и будет сообщен администратору ИС для расследования.
- Если вы реализуете интеграцию в своем коробочном решении, то вы можете провести сертификацию этого решения и получить DeveloperId. Полученный DeveloperID надо передавать из всех установок вашего коробочного решения. Подробную информацию о сертификации и условиях партнерской программы вы можете получить по адресу partners@antiplagiat.ru.
Рекомендуемый порядок действий для интеграции поиска заимствований в информационную систему:
- Посмотреть запись вебинара, прочитать ознакомительную презентацию.
- Скачать и изучить примеры на одном из языков программирования. Примеры на всех языках снабжены подробными комментариями, раскрывающими суть происходящего.
- Найти в интернете, как для вашего языка программирования можно подключить веб-сервис, если есть WSDL. Подключиться сюда.
- Встроить в вашу информационную систему вызовы API системы "Антиплагиат" и проверить ее на соответствие требованиям к интеграции.
- Отладить взаимодействие на тестовом аккаунте и сообщить в службу поддержки, что вы готовы к "боевой" интеграции. В обращении нужно указать e-mail аккаунта, от имени которого будет работать API, он не должен совпадать с аккаунтом корневого администратора, и почту с него должен читать живой человек, т.к. на этот адрес будут отправляться уведомления о технических работах и изменениях в API.
- После получения "боевых" данных измените настройки подключения вашей интеграции.
Дополнительные материалы:
Вопросы и замечания по API просим направлять на электронную почту support@antiplagiat.ru или по телефону +7 (495) 223-23-84 (доб. 2) службы технической поддержки.
Планируемые изменения
Новая функциональность
- (В проектировании) Несколько API-пользователей в компании. Для того что бы внешняя ИС могла подключиться к API ей будет предоставлен токен, а не учетные данные как сейчас. Администратор системы сможет сопоставлять пользователя в кабинет, к которому будут загружаться документы по умолчанию с токеном. Таким образом интеграторы не будут иметь доступ к учетным данным для входа в систему, а для каждой ИС будет использоваться свой токен.
- (В проектировании) Получение статистик текста документа через API.
- (В тестировании) Добавление документа в индекс будет происходить асинхронно. После выполнения команды изменения статуса индексации изменение будет происходить не мгновенно. Для каждого документа можно будет запрашивать текущий статус изменения.
- (В тестировании) Информация о типе источника (цитирование, совпадения, самоцитирование) можно будет получить через API.
Устаревшие поля
История изменений
3.9.11 - 20.04.2021
- Добавлена поддержка выгрузки pdf-документов на заданном языке FormattingOptions. Поддерживаются русский, английский, казахский и узбекский языки.
3.9.9 - 03.03.2021
- Появилась возможность генерации ссылок на отчет об обходах по полю ShortFraudReportWebId аналогично генерации всех других ссылок на отчеты. Информация об отчетах также доступна в виде структры данных ShortFraudReport.
- Появилась возможность генерации ссылок на сводный отчет о проверке SummaryReportWebId.
3.9.8 - 11.02.2021
- Появился массив для детального описания авторов загружаемого документа: DocAtributes.DocumentDescription.Authors. Аккуратное заполнение этого массива данными необходимо для корректного поиска самоцитирвоаний.
- Появилась возможность поиска самоцитирования по собственной коллекции компании. Самоцитирование ищется по проиндексированным документам компании, если при загрузке документа были заполнены ФИО или CustomID.
- Появилась возможность поиска самоцитирования по внутреннему идентификатору автора компании CustomID. Указание этого идентификатора позволяет снять все коллизии для авторов с одинаковыми фамилиями внутри компании.
3.9.6 - 22.12.2020
- Исправлена ошибка: значение GetCheckStatus(id).IsSuspicios всегда имело значение false.
3.9.5 - 03.12.2020
- Изменен порт для тестового API на 4959.
- Если у вашей компании закончились проверки, то вызов метода UploadDocument() будет приводить к исключению.
- Добавлен опциональный выбор OCR как способа извлечения текста UploadOptions.OcrExtraction.
- Добавлен опциональная возможность отключать поиск заимствований с учетом редактирования CheckDocParams.DisableFuzzySearch.
3.9.1 - 16.07.2020
- Значение "самоцитирования" теперь находится в отдельном поле класса Score. Так же отдельно вынесено значение "оригинальности".
- Обновлены примеры.
3.8.15 - 08.04.2020
3.8.8 - 24.12.2019
- Новой тип заимствований - "самоцитирование" входит в тип "цитирование".
3.8.7 - 27.11.2019
- Правки в документации. Документация стала понятнее и точнее.
3.8.4 - 27.09.2019
- Исправлена ошибка: не скачивается pdf отчет через API.
- Актуализированы примеры на php и python.
- Исправлена локализация типов документа при выгрузке справки через API.
3.8.3 - 11.09.2019
- Реализован метод EnumerateReportInfos. Метод позволяет массово и быстро получать информацию и результатах проверки для последних загруженных документах с возможностью фильтрации по ExternalUserID.
- Добавлена возможность передавать DeveloperId при добавлении документа.
- Структура атрибутов документа, передаваемая при создании и изменении документа, дополнена настройками DocumentDescription. Имя и тип документа задаются из новой из новой структуры.
3.8.2 - 26.08.2019
- Добавлена возможность формировать коллекцию документов компании одобренную для цитирования. Параметр метода SetIndexState IndexState должен быть равен "Approved".
3.8.1 - 05.08.2019
- Добавлена возможность передачи через API при загрузке документа ExternalUserId и типа документа.
3.7.17 - 22.04.2019
- В возвращаемые методами GetReportHistory() и GetReportView() объекты добавлено поле с признаком подозрительности документа.
1.9.8