Integration with LitRes service

Instructions for the “Integration with the LitRes service” add-on

What the add-on does

The add-on works with the LitRes book catalog and lets you:

• import genres and books into CS-Cart;
• create and update digital products from LitRes data;
• map genres, author, series, series number, and ISBN to store features;
• deliver files to the buyer after payment;
• send a sale notification to LitRes through the order status;
• run updates for fresh books by type and by period.

Where to find the add-on

The settings are available in the Integration with the LitRes service add-on card under Add-ons → Manage add-ons. The settings are split into the Connection, General, and Launch information tabs.

The separate sale notification option is enabled in the order status card under Administration → Orders → Order statuses. Digital product sales must be enabled in the store for the add-on to work.

Connection

On the Connection tab, enter:

• Partner ID;
• Secret key;
• Notification secret key;
• Download domain;
• Order status for a failed sale rejection from LitRes;
• Test mode.

In test mode, the add-on uses LitRes test requests and helps you check the flow without live notifications.

General settings

On the General tab, set up the links to the LitRes catalog:

• Category for the LitRes genre tree — genres are imported there;
• Author — a feature of type “Checkbox group”;
• Series — a feature of type “Text or number”;
• Series number — a feature of type “Text or number” with the correct role on the feature card;
• ISBN — a feature of type “Text or number” with the correct role on the feature card;
• Vendor — the vendor who will own the imported products.

Launch information

This tab contains the pages for running the LitRes data import.

Updating the genre list is done on the page:

admin.php?dispatch=ms_litres_integration.get_genres_list

This page loads the genre tree, creates or updates categories in the selected parent category, and uses the vendor from the settings.

Updating products is done on the page:

admin.php?dispatch=ms_litres_integration.get_fresh_book

Supported parameters:

• product_type — work type;
• from — date in YYYY-MM-DD format;
• days — interval in days;
• minutes — interval in minutes.

If product_type is not passed, the add-on updates types 0, 1, and 11. If from is provided, the period is split into intervals and updates are requested in parts.

Working with products

After import, a book becomes a standard CS-Cart digital product:

• LitRes data is filled in on the product;
• book files are created or updated;
• on the storefront, the file link is replaced with a LitRes download address;
• the download count is limited by the file setting.

Sale notification

1. Open the required order status.
2. Enable Send request to LitRes about a sale.
3. Move the order to this status after payment.

If LitRes returns an error, the add-on moves the order to the status from the “Order status for a failed sale rejection from LitRes” setting.

How to check the result

1. Enable digital product sales.
2. Fill in the LitRes connection settings.
3. Choose the genre category, features, and vendor.
4. Run the genre update.
5. Run the product update.
6. Check the imported book card and the download file.
7. Move a test order to a status with the LitRes sale request enabled.
8. Make sure the buyer sees the file and the order follows the expected notification flow.

Typical problems

• The import loads nothing. Check the Partner ID, the secret key, and the test mode in the connection settings.
• Genres are not created. Check the selected genre tree category and the permissions of the vendor who owns the products.
• The sale notification is not sent. Check that the LitRes sale request option is enabled for the required order status.