Scoped API Access

+£60/moper month — included free on Connector Core

One programmatic key into your Sage API — read-only, orders-only or read-write.

Portal Basic customers get the portal but no API keys. Scoped API access unlocks a self-serve key-issuance panel in your portal admin — issue a key for one consuming application (your accountant's practice software, a Power BI dashboard, a middleware tool) with a fixed permission scope, no ticket, no waiting for us.

Try It

sage.yourcompany.com/api — try it

GET any resource — reporting, dashboards, extracts

Gateway log

scope set to read-only — click an endpoint to fire it

How It Works

  1. 1

    Name the consumer

    In portal admin → API keys, register the consuming application yourself — name, owner, what it needs to do. e.g. 'Shopify middleware'.

  2. 2

    Pick a scope, get the key

    Choose read-only GETs, orders-only (POST sales orders + status), or read-write — the sk_live_… key is issued instantly and shown once.

  3. 3

    Gateway enforces it

    Requests outside the scope get a 403. Per-key rate limits protect Sage; every call is logged against the key.

  4. 4

    Revoke any time

    Kill the key yourself from the same panel — instantly, without touching the portal or other consumers. Useful when a tool is decommissioned or a contractor leaves.

What's Included

  • One scoped API key for one consuming application
  • Choice of scope: read-only, orders-only, or read-write
  • Per-key rate limiting and full audit trail
  • API documentation and example calls
  • Instant revocation without affecting anything else

Who It's For

Portal Basic customers who need exactly one system to talk to Sage — a reporting tool, a partner's middleware, an accountant's extract job. If you need more than one key, more than one integration, or full endpoint coverage, Connector Core is the right tier.

FAQ

Can one key call every endpoint?

Within its scope, yes — a read-only key can GET any standard resource. Scope controls verbs and resources, not rate of access.

What happens when we need a second integration?

That's the upgrade path — Connector Core includes unlimited scoped keys, so per-key economics stop mattering.

Is write access safe on the Basic tier?

We offer read-write as a scope, but recommend orders-only for Basic customers — writes are limited to sales orders, the safest mutation. Full read-write keys are better suited to Core.

Assisted Install & ConfigEcommerce Sync

Add Scoped API Access to Your Package

Pick a tier, tick this add-on and get a fixed quote.

Build Your PackageTalk to Us