The Tokens endpoints are used to obtain and manage tokens from Rutter Link. A public_token
is returned whenever a merchant successfully shares their data with you through Rutter Link. However, the public_token
cannot be used directly with our API. It must be exchanged for an access_token
via the Exchange a Token endpoint described below.
Exchange a Token
POST /item/public_token/exchangeRequest Body
client_id
stringYour Rutter API client_id
.
public_token
stringThe public_token
obtained from the Rutter Link onSuccess
callback.
secret
stringYour Rutter API secret
.
Response Body
connection_id
stringThe Rutter generated unique ID of the connection.
access_token
stringThe access token associated with the Connection.
is_ready
booleanA value determining whether all data is ready for a connection. See Connection Lifecycle for more details.
platform
enumSee our supporting Commerce Platforms or Accounting Platforms pages for the platform enumeration
store_unique_name
stringoptionalUnique store identifier.
{
"connection_id": "00000000-0000-0000-0000-000000000000",
"access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
"is_ready": true,
"platform": "SHOPIFY",
"store_unique_name": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"
}