Passthrough

Rutter offers a passthrough interface that allows you to fetch the underlying API keys and tokens that are used to make authenticated requests for each platform. Depending on the type of authentication used in the underlying platform, different fields may be returned. You should view the platform-specific API pages to properly format your request.

The endpoint to be used is below:

Fetch Connection Credentials

1
GET https://production.rutterapi.com/versioned/connections/credentials

This endpoint is available on the following platforms:

• Accounting: Dynamics 365, FreshBooks, NetSuite, QuickBooks, QuickBooks Desktop, Sage Business Cloud, Sage Intacct, Wave, Xero, Zoho Books
• Ads: Facebook, Google, TikTok
• Commerce: Amazon, BigCommerce, Chargebee, Chargify, eBay, Etsy, Lazada, Magento, MercadoLibre, PayPal, Recurly, Shopify, Shopee, Shoper, Squarespace, Stripe, Walmart, Wix, WooCommerce

OAuth

If the credential type is oauth, then an access_token property will be included along with any other required pieces of information to make a direct API call. This can be used to make authenticated requests to the platform directly.

Note: Refresh Tokens are not returned, to prevent loss of access.

1
{
2
    "credential": {
3
        "type": "oauth",
4
        "access_token": "ACCESS_TOKEN",
5
        "store_url": "test.myshopify.com"
6
    },
7
    "connection": {
8
        "id": "0f801665-5caa-4717-8ff0-9bfdb351ce11",
9
        "platform": "SHOPIFY"
10
    }
11
}

OAuth 1.0a

If the credential type is oauth1.0a, then the four fields necessary to generate an authenticated request are returned. A sample response is below:

1
{
2
    "credential": {
3
        "type": "oauth1.0a",
4
        "oauth_consumer_key": "CONSUMER_KEY",
5
        "oauth_consumer_secret": "CONSUMER_SECRET",
6
        "oauth_token": "OAUTH_TOKEN",
7
        "oauth_token_secret": "OAUTH_TOKEN_SECRET"
8
    },
9
    "connection": {
10
        "id": "0f801665-5caa-4717-8ff0-9bfdb351ce02",
11
        "platform": "ETSY"
12
    }
13
}

Basic

If the credential type is basic, then the platform API uses Basic Access authentication.

1
{
2
    "credential": {
3
        "type": "basic",
4
        "username": "USERNAME",
5
        "password": "PASSWORD"
6
    },
7
    "connection": {
8
        "id": "0f801665-5caa-4717-8ff0-9bfdb351ce02",
9
        "platform": "SHOPIFY"
10
    }
11
}

Query Params

access_token string

The access token of the connection.

Response Body

A sample response body can be found below.

1
{
2
  "credential": {
3
    "type": "oauth1.0a",
4
    "oauth_consumer_key": "CONSUMER_KEY",
5
    "oauth_consumer_secret": "CONSUMER_SECRET",
6
    "oauth_token": "OAUTH_TOKEN",
7
    "oauth_token_secret": "OAUTH_TOKEN_SECRET"
8
  },
9
  "connection": {
10
    "id": "0f801665-5caa-4717-8ff0-9bfdb351ce02",
11
    "platform": "ETSY"
12
  }
13
}

Once you have the underlying credentials of the Rutter connection, you will now be able to call the underlying platform APIs to take actions that are not available in Rutter's built-in endpoints.

For more information on specific platforms and using passthrough, please reach out to Rutter Support.