Введение

Доступ к API 

Пример ответа сервера

Введение

Доступ к API для формирования xml-отчетов позволяет партнерам получать и выгружать актуальные данные о заказах, совершенных в рамках партнерской программы «ЛитРес». Для начала работы с данным API партнеру необходимо получить от «ЛитРес» номер партнера и секретный ключ.

Доступ к API 

Доступ к API для формирования xml-отчетов происходит по URL вида:

https://www.litres.ru/refreports_by_key/?partner=< >&skey=< >&xml=<?xml version="1.0"?><request><date_from>1519928929</date_from><date_to>1746133199</date_to></request>

где:

• partner* – идентификатор партнера. Выдается при регистрации участия в партнерской программе (lfrom);
• date_from* – дата начала периода для выгрузки отчета. Дата должна быть передана в формате UNIX timestamp, например, 1519928929;
• date_to* –  дата окончания периода для выгрузки отчета. Дата должна быть передана в формате UNIX timestamp, например, 1746133199;
• new – необязательный параметр. Если будет передано значение «new=1», то в xml-отчете будут показаны все заказы, сделанные по реферальной ссылке партнера, включая отмененные и находящиеся в процессе обработки;
• skey* – подпись запроса, которую партнер формирует по приведенному ниже алгоритму. Для этого нужно использовать секретный ключ-код, выданный при подключении к этому API, и те же даты (date_from и date_to), которые будут переданы в URL.

  Алгоритм формирования skey:

  Digest::MD5::md5_hex ($PartnerPwd . $From . $To)

  Параметры, обозначенные красной звездочкой (*), являются обязательными.

Пример ответа сервера

<item>
	<click_id>6cf29c05a41b6fd9</click_id>
	<order_id>1014443096</order_id>
	<user_type>new</user_type>
	<status>done</status>
	<date>1519928929</date>
	<order_total>36.00</order_total>
	<order_total_no_nds>36.00</order_total_no_nds>
	<currency>RUR</currency>
	<basket>
		<product>
			<pid>307872</pid>
			<pc>book</pc>
			<pn>Ваш малыш. Уход за ребенком от рождения до года</pn>
			<up>36.00</up>
			<qty>1</qty>
			<status>approved</status>
		</product>
	</basket>
	<commission>9.36</commission>
</item>
<item>
	<click_id>6cf29c04ac1a6fdb</click_id>
	<order_id>1014499740</order_id>
	<user_type>current</user_type>
	<status>done</status>
	<date>1519932144</date>
	<order_total>164.00</order_total>
	<order_total_no_nds>164.00</order_total_no_nds>
	<currency>RUR</currency>
	<basket>
		<product>
			<pid>24938710</pid>
			<pc>book</pc>
			<pn>Претендентка номер девять</pn>
			<up>164.00</up>
			<qty>1</qty>
			<status>approved</status>
		</product>
	</basket>
	<commission>21.32</commission>
</item>
<item>
	<click_id>6cf29c05a4186fdc</click_id>
	<order_id>1014572216</order_id>
	<user_type>new</user_type>
	<status>done</status>
	<date>1519936280</date>
	<order_total>124.50</order_total>
	<order_total_no_nds>124.50</order_total_no_nds>
	<currency>RUR</currency>
	<basket>
		<product>
			<pid>18979323</pid>
			<pc>book</pc>
			<pn>
			Справочник здравомыслящих родителей. Часть вторая. Неотложная помощь
			</pn>
			<up>124.50</up>
			<qty>1</qty>
			<status>approved</status>
		</product>
	</basket>
	<commission>32.37</commission>
</item>

Сформированный xml-отчет содержит следующие параметры:

• item/@click_id – идентификатор перехода пользователя по реферальной ссылке партнера;

• item/@order_id – идентификатор заказа, который оформлен по реферальной ссылке партнера;

• item/@user_type – тип пользователя, который сделал заказ. Может принимать значения:
  • new – новый покупатель;
  • current – постоянный покупатель;
• item/@status – статус заказа. Для выполненных заказов этот атрибут имеет значение «done»;
• item/@date – дата заказа. Указана в формате UNIX timestamp;
• item/@order_total – общая стоимость заказа;
• item/@order_total_no_nds – общая стоимость заказа без НДС. Условия налоговой нагрузки партнера (режим налогообложения) сообщаются партнером при подключении к «ЛитРес»;
• item/@currency – код валюты заказа. Допускаются значения EUR, USD, GBP, AUD, CAD, RUR, NZD. По умолчанию считается равным RUR (российский рубль), а любые значения, отличные от рубля, следует явно оговаривать при подключении к «ЛитРес»;
• item/@basket – атрибут, указывающий какие именно книги содержатся в заказе;
  • item/@basket/@product – атрибут, описывающий параметры каждой книги, купленной в рамках заказа:
    • pid – идентификатор книги; 
    • pc – тип книги:
      • book – текстовый формат;
      • audiobook – аудио формат; 
    • pn – наименование книги;
    • up – стоимость экземпляра книги;
    • qty – количество экземпляров книги в заказе;
    • status – статус заказа. Данный атрибут будет возвращен в xml-отчете партера, только если в запросе был передан параметр «new=1». Может иметь значение:
      • approved – заказ подтвержден;
      • processing – заказ находится в обработке;
      • denied – заказ отменен;
  • item/@basket/@commission – вознаграждение, выплачиваемое партнеру за заказ, оформленный по его реферальной ссылке.