Admin panel

Use the SureBright page in your Magento admin to check that the integration is authorised, open the merchant portal, run the built-in checks when something is not working, and disable or reinstall the module.

After the module is installed, a SureBright item appears in the Magento admin sidebar. It opens the SureBright Product Protection page. Use it right after installing, and whenever offers stop showing or plans you sold stop appearing as contracts.

You want toDo this
See whether the integration is workingCheck Status at the top of the page.
Open the merchant portalClick Login Now.
Finish or renew authorisationFollow the steps under Authorization pending or Reauthorization required.
Find out why offers or contracts stoppedExpand Diagnostics and run the checks.
Find an order that did not reach SureBrightOpen the SureBright Webhook Errors grid.
Turn the module off or on, or move to a new versionRun the commands under Disabling or removing the module.

Check status and open the merchant portal#

The header reads Merchant Portal: Manage product protection, policies, sales and invoices. Under it you see:

  • Status: Authorized when the SureBright Product Protection integration is active in Magento, otherwise Authorization pending.

  • Installed version: the version of the module on your server, for example 1.3.15. The latest release is v1.3.15; see Reinstall to move to it.

  • Login Now: once the status is Authorized, this button opens the SureBright merchant portal sign-in page in a new tab. Log in with the credentials shared by the SureBright team. Before authorisation, the page tells you that the SureBright team shares your login credentials once authorisation is complete.

Authorise or reauthorise the integration#

Authorization pending shows until you activate the integration. The page lists the steps and offers a Go to Integrations button:

  1. Open System > Extensions > Integrations.

  2. Find SureBright Product Protection and click Activate.

  3. Review the requested access and confirm.

Reauthorization required shows when a module update needs permissions you have not granted yet. Magento does not grant new permissions on its own, so the page marks the missing ones not granted and asks you to:

  1. Open System > Extensions > Integrations. The row shows that its resources changed.

  2. Open SureBright Product Protection, confirm the new resources are checked, and Save.

  3. Click Reauthorize to apply the new permissions.

Until you reauthorise, SureBright cannot read the data behind the missing permissions.

If activation or reauthorisation fails#

When you click Activate or Reauthorize, Magento and SureBright exchange keys over the internet, so SureBright must be able to reach your store. Activation fails when a firewall, a hosting security rule or an IP allow-list blocks SureBright. This is common on development and staging sites, which are often closed to outside traffic.

  1. Get SureBright's addresses

    Ask your SureBright contact, or support@surebright.com, for the addresses SureBright connects from.

  2. Allow them

    Add them to the allow-list on your firewall, hosting panel or security service, for every site you connect, including development and staging sites.

  3. Try again

    Open System > Extensions > Integrations and click Activate or Reauthorize on SureBright Product Protection again.

If it still fails, send SureBright the exact error message and your store URL.

Run the SureBright diagnostic checks#

Expand Diagnostics (subtitle Access, webhook, reindex & cache checks) to reach four checks. Each one runs from your browser and shows its result on the page. Nothing changes in your store except where noted.

Check which permissions are granted#

Under Access & Permissions there is one card per group of Magento permissions the integration asks for, with a granted / total count and a granted or not granted pill for each resource. Click Run test on a card to try a real read of that data and see whether it worked.

CardWhat it covers
Backend AccessAdmin, system and store-view configuration scope.
Sales AccessRead orders, credit memos and shipments.
Catalog AccessRead products, categories and attributes.
Customer InformationRead customer accounts and groups.
Inventory AccessRead inventory sources and stock levels.
SureBright Custom APISureBright integration data and event APIs.

If an authorised integration shows a not granted pill, you need to reauthorise.

Test that your server can reach SureBright#

Under Webhook Connectivity, click Test webhook. Your server sends a test message to SureBright and the page shows the result. If it fails, the message tells you what to fix:

MessageWhat to do
No active SureBright integration foundThe integration is not activated. Authorise it first.
Stored SureBright credentials are incompleteAuthorisation did not finish. Reauthorise.
Could not reach SureBrightYour server could not connect. Check for an outbound firewall or DNS problem.

Your orders and product changes reach SureBright the same way, so a failing test means SureBright is not hearing about your orders.

Rebuild indexes so SureBright sees current products#

Under Reindex, click Reindex now to rebuild every Magento indexer so SureBright reads current catalogue, price and stock data. It is the same as running bin/magento indexer:reindex and can take a while on a large catalogue. The result lists each indexer with Reindexed or the error it raised.

Purge caches after a change#

Under Cache, click Purge caches after authorising, reauthorising or changing the module, so the storefront picks up the change. It cleans the cache types that affect SureBright: integration and web API configuration, layout, block HTML and full page. The result lists each cache type with Cleaned, Not present on this install; skipped, or an error.

Find orders that did not reach SureBright#

Orders and product changes that failed to reach SureBright are listed in the SureBright Webhook Errors grid at <admin URL>/surebright/webhookerror/index. Each row shows when it happened (Created At), what it was about (Event Type, Entity ID, SKU, Store ID) and what went wrong (Error Type, HTTP Status, Error Message, plus the request and response). When an order has no contract, find its row and share it with SureBright support.

Disabling or removing the module#

You turn the module off, turn it on again, or reinstall it from the command line on your Magento server. Removing the module does not cancel existing contracts. SureBright keeps serving them and your customers can still file claims.

Disable the module#

bash
php bin/magento module:disable Surebright_Integration --clear-static-content
bin/magento setup:di:compile
bin/magento cache:clean

The SureBright page in the admin and the storefront widgets disappear. While the module is off, your orders are not sent to SureBright, so orders placed in that time do not become contracts.

Enable the module again#

bash
php bin/magento module:enable Surebright_Integration
bin/magento setup:di:compile
bin/magento cache:clean

Reinstall#

Use this when support asks you to move to a new version or when the module files are damaged.

  1. Disable and remove the current version

    bash
    php bin/magento module:disable Surebright_Integration --clear-static-content
    bin/magento setup:di:compile
    composer remove surebright/integration
    bin/magento setup:upgrade
    bin/magento setup:static-content:deploy -f -j5
    bin/magento cache:clean
  2. Install the version SureBright gave you

    Replace the version tag with the one in the release note you received, for example v1.3.15.

    bash
    composer require surebright/integration:v1.3.15
    php bin/magento module:enable Surebright_Integration
    bin/magento setup:upgrade
    bin/magento setup:di:compile
  3. Deploy static content and flush the cache

    bash
    bin/magento setup:static-content:deploy -f -j5
    php bin/magento cache:flush

    Then open the SureBright page in the admin and check that the status shows the new version and Authorized. If it asks you to sign in again, use Login Now.