Spaidoo user?Open your universal library.
Connector API

Connect your platform to Spaidoo

Does your store run on another platform, or do you build e-commerce software? With the Connector API, any platform can have its own Spaidoo connector.

v1 specification published · step-by-step guide · online check

What a connector does

Five pieces. None of them depends on a particular platform.

  • 01

    Store connection

    The store signs up from its panel, gets its key and connects. Also leaving, and the widget's settings.

  • 02

    Customer identity

    If the customer is signed in to the store, the connector confirms it with an HMAC signature and their list is waiting for them.

  • 03

    Catalogue

    A Google Merchant feed per language, with prices in every currency. Spaidoo reads it and keeps it up to date.

  • 04

    Storefront

    The widget's script and the save buttons, marked with data-* attributes. Nothing at checkout.

  • 05

    Signed calls

    When Spaidoo needs something from the store, such as its customers' emails, the call is signed and timestamped.

Open standards

  • JSON over HTTPS

    Every call between the connector and Spaidoo.

  • HMAC-SHA256

    To sign the customer's identity and Spaidoo's calls to the store.

  • Google Merchant

    The catalogue format almost every platform can already produce.

  • data-* attributes

    To tell the widget where the save buttons go, without touching the theme.

How to start

  1. 1

    Read the guide

    Step by step, with diagrams and code samples: what the connector does and in what order.

    Start the guide
  2. 2

    Connect a test shop

    An installation of your platform reachable from the internet, connected to Spaidoo with your connector.

  3. 3

    Pass the check

    It tests your connector against the specification and tells you what fails and in which section.

  4. 4

    Ask for help when you need it

    Spaidoo partners with access have an assistant that knows the specification. And we are on the other side.

Frequently asked questions

01Can I use Spaidoo without a connector?
Yes. The widget works on any store with one line of code. The connector adds customer identity, the synced catalogue and communication.
02Where is the technical documentation?
At developers.spaidoo.com: the full v1 specification, a step-by-step guide and the online check. In English and Spanish.
03Is there help while I build it?
Yes. Spaidoo partners can get access to an assistant that knows the specification and the reference connector, and reads the check's report. And you can always write to us.

Which platform do you want to connect?

Read the documentation