Версия документа | 2.0 |
---|---|
Дата последнего обновления | Октябрь 2012 г. |
Адрес постоянного размещения | https://docs.litres.ru/x/JAUT |
Методика передачи данных
Статистика должна передаваться от партнера к ЛитРес ежечасно по протоколу FTP. Реквизиты для подключения к серверу FTP:
- Хост: ftp.litres.ru.
- Логин: <выдается при подключении, уточняйте у менеджера>.
- Пароль: <выдается при подключении, уточняйте у менеджера>.
Имя файлов со статистикой должно составляться по времени формирования файла со статистикой в виде:
YYYY-MM-DD-HH-mm.xml (например, «2008-12-22-13-00.xml»).
Партнер должен не реже, чем раз в час, пытаться выгружать свежую статистику на сервер ЛитРес.
В случае, если FTP-сервер ЛитРес недоступен, партнер должен во время следующей сессии попытаться загрузить старые данные повторно, и так до тех пор, пока данные не будут выгружены успешно.
Старые данные можно как включать в новый файл, так и загружать несколько файлов во время одной сессии.
При технических неполадках на стороне партнера допускается задержка в выгрузке статистики не более трех рабочих дней.
Формат передаваемых данных
Данные передаются в виде XML файла. Для упрощения ручной идентификации ошибок XML-файл должен включать «разрыв строки» после каждого узла <r/>.
Формат вашего файла можно проверить на данной W3C XML-схеме.
<online-reading-report xmlns="http://www.litres.ru/Pub/Partners/OnlineReadingReport" partner="PRTNRID"> <r a="120421" c="4" t="2007-08-26T22:49:17" p="0" u="100500" i="192.168.0.100" m="s"/> <r a="120421" c="0" t="2007-08-26T22:55:35" p="1" u="100500" i="192.168.0.100" m="m"/> <r a="135120" c="0" t="2007-08-26T22:56:40+03:00" p="5" u="48c86696c1194c3029b4f112d8069124" i="192.168.132.5" m="s"/> <r a="120421" c="0" t="2007-08-26T22:59:09" p="5" u="100500" i="192.168.0.100" m="d" d="www.fake.ru"/> <r a="135120" c="0" t="2007-08-26T23:00:17" p="6" u="48c86696c1194c3029b4f112d8069124" i="192.168.132.5" m="s"/> </online-reading-report>
Описание атрибутов узла r (read)::
- @a – ID книги (от слова art). Должно соответствовать атрибуту updated-book/@id из get_fresh_book;
- @c – категория произведения (определяет тип контента: текст, PDF, аудио). Значение должно соответствовать атрибуту updated-book/@type из get_fresh_book;
- @t – время (от слова time), когда было зарегистрировано чтение. Время в xsd:dateTime. Если не указан часовой пояс, время считается Московским;
- @p – страница, к которой был осуществлен доступ (от слова page). Для книг в PDF-формате (атрибут @c="4") в атрибуте @p указывается соответствующий номер страницы чтения. Если книга в текстовом формате (атрибут @c="0") следует делить текст на «страницы» исходя из понятия «авторский лист». То есть одна страница должна соответствовать 40000 знаков (включая пробелы и знаки препинания). Ювелирная точность в определении страниц не обязательна, но хотя бы статистическое приближение к этой величине приветствуется;
- @u – идентификатор пользователя на стороне партнера (от слова user). Допускается любая строка длиной до 100 символов включительно. Атрибут является обязательным. Если вы отдаете документ анонимному пользователю, передавайте его персональный SID, хранящийся в cookies, или любую другую информацию, которая позволит определить, что доступ предоставлен тому же лицу и избежать двойной оплаты за доступ;
- @i – IP-адрес пользователя, с которого осуществлялось чтение;
- @m – режим, в котором осуществлялось чтение с точки зрения партнера. Из-за того, что обновление статуса произведения у партнера осуществляется не в реальном времени, возможна ситуация, когда в момент чтения у партнера на стороне ЛитРес документ уже сменил статус. Чтобы разрешать подобные коллизии желательно иметь информацию о том, как выглядели права на книгу в момент чтения на стороне партнера. Возможные значения:
- s – осуществлен доступ к странице документа, доступной в режиме стриминга;
- m – осуществлен доступ к документу, доступному только как PPD (pay per download), но недоступному в режиме стриминга;
- d – осуществлен повторный доступ к документу, доступному только как PPD. Имейте в виду, что биллинговая система ЛитРес пытается самостоятельно вычленять такую ситуацию и PPD-документ N переданный пользователю M, по идее, продан будет только при первом обращении, а все последующие чтения будут проходить без «последствий». Но точка зрения партнера на эту ситуацию будет весьма полезна для разъяснения спорных ситуаций и устранения проблем;Также следует иметь в виду, что книги, доступные в режиме «стриминг», «не понимают» повторного чтения за рамками одной сессии, т. е. если человек просматривает в течение часа (в рамках одной сессии) одну страницу сто раз, это считается как одно чтение, а если человек просматривает по часу одну и ту же страницу сто дней подряд, это следует фиксировать как сто онлайн-чтений и отчитываться соответственно;
- @d – домен, на котором было произведено онлайн-чтение (строка). Атрибут необходим в том случае, если партнер использует несколько доменов.