Skip to content
Developers

Spaidoo Connector API v1

Connect any platform to Spaidoo.

A connector lives inside a shop platform (a module, an app, a plugin, a headless backend) and gives Spaidoo what a script alone cannot: the catalog, the signed-in customer and push notifications from the shop's own domain.

Start the guideRead the specification
  • Public specification
  • Any platform
  • Online conformance check
  1. 01Start here

    Build a connector, step by step

    From pairing to a conformance check with no failures: every step with its diagram, the minimal code and how to know it works.

    Start the guide
  2. 02

    The specification

    The full contract: pairing, catalog, identity, signed calls and what the connector prints on the storefront.

    Read the specification
  3. 03Partners

    Conformance check

    In the partner area you check a test installation with your connector online, capability by capability, every failure linked to its section.

    Go to the partner area

How it fits

Your connector, between the shop, the browser and Spaidoo.

The connector declares the capabilities it implements and Spaidoo acts on that declaration, never on the name of the platform. That is why any platform can build one.

The minimum is pairing, the handshake and the product feed, plus the script on the storefront. Everything else is an independent piece, declared and checked on its own.

The whole picture: your connector between the shop, the shopper's browser and SpaidooShopper's browser. Shop platform + your connector. Spaidoo. Shop page with the widget. Push notifications from the shop's domain. Storefront pages storefront.saveAnchors. Identity route identity. Push worker push. Product feed catalog.feed. Customers route customers. Verify route domainVerification. Calls to Spaidoo handshake · catalog.changes customerErase · wishlistImport. Widget loader scriptUrl. Spaidoo sync. Spaidoo API /connector/v1. the page loads the widget. script, SpaidooConfig, save anchors. who is browsing?. registers it. reads it daily. signed call. reads the code. Bearer <apiKey>Shopper's browserShop platform + your connectorSpaidooShop pagewith the widgetPush notificationsfrom the shop's domainStorefront pagesstorefront.saveAnchorsIdentity routeidentityPush workerpushProduct feedcatalog.feedCustomers routecustomersVerify routedomainVerificationCalls to Spaidoohandshake · catalog.changescustomerErase · wishlistImportWidget loaderscriptUrlSpaidoo syncSpaidoo API/connector/v1the page loads the widgetscript, SpaidooConfig,save anchorswho is browsing?registers itreads it dailysigned callreads the codeBearer <apiKey>
Arrows point from who asks to who answers. The capabilities sit where they live: routes the shop serves, what it prints on its pages, and the calls the connector makes to Spaidoo.

For Spaidoo partners

Ask the assistant.

Partners with access to the developers area get an assistant that knows the specification inside out. Hand it a conformance report and it tells you why it fails and how to fix it.

  • Answers that link to the specification's sections.
  • A conformance report, straight into the conversation.
  • Your conversations are kept.
Open the assistant

Connector API assistant

Answers from the specification

The identity check says my assertion has expired. Why?

An assertion lives 60 s at most (exp - iat) and Spaidoo tolerates 30 s of clock skew. If the route caches it or the server's clock drifts, it arrives expired: sign a fresh one on every request, with Cache-Control: no-store, and keep the clock on time.

§5.1§5.2

Example conversation