post https://production.rutterapi.com/connections/create
Generates new connections programmatically. POST body is optional, unless you are creating a connection with existing credentials/tokens.
Create connections programmatically using the Create a Connection API. There are two ways to use this API:
- Create a connection URL that allows the merchant to select which platform they want to connect. This is done by leaving the request body empty.
- Create a connection with existing credentials. This is done by specifying the platform and including the associated credentials (OAuth, Basic Auth, etc.) for the connection. Rutter will use these fields to make the authenticated API requests to the platform. To see what values are required for each platform, see the Platform Specific Required Body Params table below or contact [email protected] for more support.
Request Properties
Platform Specific Required Body Params
Platform | Required Body Params |
---|---|
Amazon Selling Partner API | oauth_client_id : SP-API App Client IDoauth_client_secret : SP-API App Client Secretoauth_refresh_token : SP-API Refresh Tokenamazon_access_key_id : AWS User Access Key IDamazon_secret_access_key : AWS User Secret Access Keyamazon_selling_partner_role : AWS Role ARN used in SP-API appamazon_seller_region : Region of Amazon seller - must be one of na (North America), eu (Europe), or fe (Far East). |
BigCommerce Connector App | store_url : BigCommerce merchant .mybigcommerce.com domain URLoauth_access_token : BigCommerce Store Access Token |
BigCommerce Single-Click App | store_url : BigCommerce merchant .mybigcommerce.com domain URLoauth_client_id : BigCommerce App Client IDoauth_client_secret : BigCommerce App Client Secretoauth_access_token : BigCommerce Store Access Token |
Ebay | oauth_client_id : Ebay Developer OAuth Client IDoauth_client_secret : Ebay Developer OAuth Client Secretoauth_refresh_token : Ebay OAuth Refresh Token |
FNAC | partner_id : FNAC Partner IDshop_id : FNAC Shop IDkey : FNAC Key |
Lazada | oauth_client_id : OAuth Client IDoauth_client_secret : OAuth Client Secretoauth_access_token : OAuth Access Tokenoauth_refresh_token : OAuth Refresh Tokencountry : Country Code for Merchant (e.g. id , sg , th ) |
Magento | store_url : Magento merchant website URLbasic_username : Magento Admin User Usernamebasic_password : Magento Admin User Password |
PrestaShop API | store_url : PrestaShop merchant domain URLapi_key : PrestaShop API Key |
Quickbooks Online | oauth_client_id : OAuth Client IDoauth_client_secret : OAuth Client Secretoauth_refresh_token : OAuth Refresh Tokenrealm_id : The Company ID which the app wants to accessenvironment : "sandbox" | "production" |
Shoper | store_url : Shoper merchant domain URLoauth_access_token : Shoper merchant OAuth Access Tokenoauth_refresh_token : Shoper merchant OAuth Refresh Token |
Shopify Private App | store_url : Shopify merchant .myshopify.com domain URLbasic_username : Private Shopify App API Keybasic_password : Private Shopify App Password |
Shopify Public App | platform : SHOPIFYstore_url : Shopify merchant .myshopify.com domain URLoauth_client_id : Shopify App Client IDoauth_client_secret : Shopify App Client Secretoauth_access_token : Shopify Merchant Access Tokenoauth_refresh_token : Shopify Merchant Refresh Token |
Square | oauth_client_id : Square Developer OAuth Client IDoauth_client_secret : Square Developer OAuth Client Secretoauth_refresh_token : Square OAuth Refresh Token |
Stripe | oauth_access_token : Stripe OAuth Access Tokenaccount_id Stripe Account ID |
WooCommerce | store_url : WooCommerce merchant website URLbasic_username : WooCommerce Rest API Consumer Keybasic_password : WooCommerce Rest API Consumer Secret |
Response Properties
Property | Type | Description |
---|---|---|
connection | object | Object containing connection properties. |
id | string | The Rutter ID of the connection. This value is a UUID generated by Rutter that uniquely identifies a connection regardless of the platform. |
access_token | string | Our APIs use access tokens when making API calls for an established business connection. This is obtained by exchanging the public token for an access token using our Exchange Token API. See Token Exchange for more information on the exchange flow. |
link_url | string | This is a unique and stable link that can be sent to a business to authenticate their business to Rutter. |