Migrate to Rutter

Migrating to Rutter

Rutter's Connection API enables seamless migration of your existing customers’ connections from a self-managed or other managed integration to Rutter, without requiring your customers to re-authorize the connection.

Note: If migrating Netsuite, an extra step is required to install the Rutter bundle/extension. After that, it should work normally with the token exchange. More information on the Netsuite bundle can be found at this page.

Note: This migration guide does not apply to QuickBooks Desktop today, nor any desktop platforms that we support. For all existing connections migrated from QuickBooks Desktop, users will need to reauthenticate using Rutter Link.

Step 1: Retrieve OAuth access token & client secret from the platform

When migrating from another managed integration solution like Codat, you'll need to obtain your customers' existing credentials for each platform. Once you have the credentials, you can use them with Rutter's API to create authenticated connections.

Here's how to proceed:

Contact the support team of your current integration provider to request a list of your customers' existing credentials for each platform
The required credentials vary by platform. To determine the specific values needed for each platform, refer to the Platform Specific Required Body Params table in our documentation

Example credentials for QuickBooks:

OAuth Client ID
Realm ID
OAuth Client Secret
OAuth Refresh Token
Environment

Example credentials for NetSuite:

Token ID
Consumer Key
Consumer Secret
Store Name
Token Secret

If you need additional assistance or have questions about the migration process, don't hesitate to reach out to Rutter's support team at support@rutterapi.com.

Step 2: Create a Rutter Connection using the Create a Connection API endpoint

For every customer you migrate to Rutter, you’ll use the Create a Connection API endpoint to programmatically establish a new Rutter connection representing a link between that customer and the source platform you want to pull data from (such as Shopify or QuickBooks).

You can create a connection with the customer’s existing credentials by calling our Create Connection API and specifying the platform and including associated authentication details. See this page for all required fields you need to use for the request parameters for each platform.

Example Request Body

1{
2  "platform": "SHOPIFY",
3  "oauth_client_id": "CLIENT_ID",
4  "oauth_access_token": "ACCESS_TOKEN",
5  "oauth_client_secret": "CLIENT_SECRET"
6}

Example Response Body

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "access_token": "00000000-0000-0000-0000-000000000000",
5    "link_url": "https://link.rutterapi.com/connection/00000000-0000-0000-0000-000000000000",
6    "name": "Example Connection"
7  }
8}

After successfully creating Rutter connections, the following processes will take place:

Data Sync Initiation: Rutter automatically begins synchronizing data with your customers' platforms.
Historical Data Backfill: This sync process fetches all historical data according to the data sync configuration you've set in your Rutter developer portal.
Sync Completion: Once the data synchronization is complete, you'll have full access to your customers' data through Rutter's API.
API Access: You can now start making API requests to your clients' platforms using the access_token generated from the Create a Connection API.

We recommend implementing a phased migration approach, focusing on one company at a time for each platform. This allows you to identify and resolve any potential issues specific to each integration platform and minimizes the potential disruption to business operation.

After each company’s migration, it is crucial to conduct thorough end-to-end testing. This testing will ensure no reauthorization is required for any users and will verify that the data synchronization processes are completed accurately.