31 Compact logo31 COMPACTUser manual
Open application ↗Complete manual

Web portal

Connector

Connect authorised desktop/mobile clients to the business API and understand user access.

In this moduleUnderstand the workflowField referenceUse the approved native application connectionReview an access or authorisation problemPractical exampleCommon questions

Understand the workflow

Connector is an administrator-managed API authorisation area. Ordinary staff use the supplied native app connection and their own portal account. An authorised API client does not bypass role, tenant or location access. Keep client configuration and access tokens private; the current native public-client PKCE flow does not require an embedded client secret.

Native sign-in uses the approved portal connection; API documentation and staff permissions remain administrator-managed
SCREEN GUIDE Native sign-in uses the approved portal connection; API documentation and staff permissions remain administrator-managed. Select the screenshot to enlarge; optional fields may differ in your business.

Field reference

Use this while completing the form. A required field is marked with *; conditional fields appear only when enabled.

Field / controlWhat to enter or understand
Approved clientApplication identity authorised for the portal.
Redirect / callbackAllowed destination where browser sign-in returns to the app.
User authorisationStaff login and granted session; it remains scoped by role/business.
API access / limitsConfigured subscription/access controls and endpoint availability.

PROCEDURE 01

Use the approved native application connection

Where to go Windows / Android → Live API sign-in

Before you start
Use the official app build and supplied portal connection.

Steps

  1. Confirm the server is the approved HTTPS Compact portal and the app is in Live API mode.
  2. Launch browser authorisation, sign in using your own account and complete the ordinary CAPTCHA when requested.
  3. Return through the approved callback and wait for business data to load.
  4. Check business/outlet/user access and review the register before trading.
  5. For connection errors, provide a sanitized message/time to the administrator rather than changing shared OAuth settings.

Check the result
The app is connected under the intended staff permissions.

PROCEDURE 02

Review an access or authorisation problem

Where to go Connector administrator; native sign-in

Before you start
Separate authentication from business data/permission failures.

Steps

  1. Check whether browser sign-in completed and returned to the app.
  2. Confirm the approved client/callback with the administrator if the portal reports an authorisation error.
  3. For a signed-in app with missing data, check subscription, staff role and permitted outlets separately.
  4. Use sign-out/sign-in or the offered refresh as appropriate; preserve pending offline work.
  5. Do not grant broad administrator permissions solely to make a cashier’s API request succeed.

Check the result
The actual authentication or access cause is identified.

IN PRACTICE

A practical example

The same live cashier account signs into Windows and Android through the approved client. It still sees only its permitted locations; creating an API connection does not grant administrator rights.

Common questions

Should I change the client ID to fix stock?

No. Verify outlet/data/permissions first and use the administrator’s approved connection.

Where should I share tokens?

Do not include them in screenshots, messages or user documentation. Use the approved support procedure.