Rutter

The Rutter Developer Hub

Welcome to the Rutter developer hub. You'll find comprehensive guides and documentation to help you start working with Rutter as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Introduction to Link

The Basics

Rutter Link is the client-side component that your users will interact with in order to link their accounts to Rutter and allow you to access their accounts via the Rutter API.

Rutter Link will handle credential validation, OAuth, and error handling for each platform that we support. Link works across all modern browsers and platforms, including web, iOS, Android, and mobile webviews.

Web

On web instances (React & JavaScript), loading the Rutter JS will create a global Rutter object on the window object. To open the Merchant Auth flow, you must call Rutter.create() while passing in your public_key, and then open() on the resulting object.

Create

The create function takes in an object as an argument. Below is an example:

const rutterInstance = Rutter.create({
  publicKey: "YOUR_RUTTER_PUBLIC_KEY",
  onSuccess: function (publicToken) {
    // Send publicToken to your backend and exchange
    // https://docs.rutterapi.com/reference#exchange-tokens
    console.log("public token: " + publicToken)
  },
  onError: function (error) {
    console.error(error);
  }
})

After the Rutter Instance is created, the resulting object has the following functions:

Open

The open function opens the Merchant Auth popup, and will return a publicToken after a successful authentication to the callback you specified in the create function above. Below is an example:

// Assuming rutterInstance has already been created as shown above

// Opens the Rutter popup
rutterInstance.open()

// Opens the Rutter popup directly to the Shopify Auth Step
rutterInstance.open({
  platform: "SHOPIFY"
})

The following values for platform are supported:

  • SHOPIFY
  • MAGENTO
  • BIG_COMMERCE
  • WOO_COMMERCE
  • SQUARESPACE
  • WIX
  • SQUARE
  • AMAZON
  • EBAY
  • ETSY
  • PRESTASHOP

Updated 2 months ago


What's Next

React Quickstart

Introduction to Link


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.