Shield

Shield

Shield connects Max to your MaxShield systems and mirrors what each reports. MaxShield routes shop payments through intermediary sites and rotates the payment gateways it uses. Here you see its numbers, sites, gateways and transactions, and you can make a few changes (module shield).

In the sidebar under Servers & apps → Shield. Needs: nothing. Sensitive: it handles money and holds secrets, so every change an agent makes here goes to a person.

Instances

Each MaxShield connection, its status, its version, and whether Max can reach it.

To connect one:

  1. Click Connect with MaxShield.
  2. Your MaxShield opens. An admin there presses Allow. No key is copied by hand.
  3. You come back to Max with a note saying it connected, or that it was declined and nothing was stored.

The key is stored encrypted and never shown again. You can test an instance, sync it now, rename or switch it off, or remove it.

Overview

For the chosen instance: order volume, revenue, refunds, the health of shields and gateways, the webhook relay, and node counts.

Sites

The stores and clean checkouts the instance manages, with order and revenue counts and health. Create site on MaxShield adds one: a "main" site is the real store, a "shield" site is the clean checkout.

Gateways

The payment shields, with their kind, rotation method, whether each is active or selected, errors, and volume against its limit. You can create a gateway, switch one on or off, or force a rotation.

Transactions

Transactions the instance handled. Filter by status.

Who can do what

PermissionLets you
shield:readView shield: instances and everything they report
shield:writeManage shield: connect, test, sync, create sites and gateways, switch gateways and force a rotation

What happens on its own

JobWhenWhat it does
syncEvery 15 minutesPulls each instance's statistics and data and updates the copy here. Nothing at MaxShield changes.

Needs

Nothing else needs to be switched on.

What agents can do

Look (read-only, runs straight away)

  • shield.list: connected instances and their last sync.
  • shield.overview: one instance's full statistics.
  • shield.listSites, shield.listGateways, shield.listTransactions.

Act (asks a person)

  • shield.sync: brings the copy up to date.
  • shield.test: checks the instance answers.
  • shield.createSite: adds a real store or a clean checkout. The site key is never returned.
  • shield.createGateway: adds a payment shield. Its payment key is named by a secret a person stored in Named secrets, never typed.
  • shield.toggleGateway: switches a gateway on or off.
  • shield.rotateGateway: forces a rotation.