Installation
Requirements
Section titled “Requirements”- CS-Cart or Multi-Vendor 4.17.2 to 4.21.x (Ultimate or Multi-Vendor edition), PHP 7.4 to 8.3.
- The primary currency of the store is EUR.
- A Lexware Office account. The Public API is available with the Lexware Office plans that include it; the connection test tells you if your key is accepted.
- An API key: in Lexware Office open Settings, Public API (app.lexware.de/addons/public-api) and create a key. Keep it secret; anybody with the key can read and create documents in your account.
- A cron job or a scheduler that opens the cron address every minute (see Configuration).
Install
Section titled “Install”- Upload the add-on package in Administration > Add-ons > Manage add-ons > Upload & install add-on, or copy it to the store and install it from the list.
- Open the add-on settings (Orders > Lexware Office documents has the working pages). The add-on creates its tables and a secret cron key.
Connect
Section titled “Connect”- Orders > Lexware Office documents > Connection. Paste the API key into the field of the mode you want to start with and press Save and test.
- The test calls the Lexware Office profile. A green message shows the company name of your account; the page then lists the organization, the tax type of your account and whether it is a small business.
- Lexware Office has no sandbox. For a trial run create a free trial account in Lexware Office (it has all features for 30 days), put its key into Test API key, and keep the mode on Test. Switch to Live with the live key when everything looks right.
- Press Register subscriptions so Lexware Office tells the store when an invoice is paid. This needs a public address with a valid HTTPS certificate. Without it the add-on checks open invoices every 15 minutes anyway.
Update
Section titled “Update”Upload the new package over the old one. Settings, the API key and the document list are kept; missing tables and settings are added automatically.
Uninstall
Section titled “Uninstall”Uninstalling removes the add-on tables (including the stored API key and the document list). Documents already created in Lexware Office are not touched. Remove the event subscriptions on the Connection page first if you want them gone at Lexware Office; Lexware Office also removes them when the key is renewed.