Access your customer dashboad
client_id
and secret
, which you will use as the basic auth username and password for your API key respectively. Note that your client_id
and secret
vary between thedevelopment
and production
environments.Subscribe to webhooks
Retrieve available merchants
type = shopping
. These are merchants you can display in your app, allow users to link, and subsequently shop at. To get started quickly, you can use merchant_id: 45
for Walmart to later pass when initializing the SDK.You will be notified via the MERCHANT_STATUS_UPDATE
webhook when/if this list changes.Create a session
client_id
and secret
for the development
environment, call Create Session with type: link
to create a session used when invoking the SDK.Install the SDK
development
and production
environments in your Customer Dashboard.Initialize the SDK
session_id
retrieved from Create Session. In KnotConfiguration
, pass a merchant Id
retrieved from List Merchants or you can use merchant_id: 45
for Walmart to get started quickly. The SDK is where users will interact with the Knot UI to link various merchant accounts. All login flows, including step-up authentication, are handled within the SDK. Users will see real-time feedback as they link a merchant account.Id
in KnotConfiguration
is required when initializing the SDK with a session with type: link
.Login
user_good
/ pass_good
credentials to link your user’s merchant account.Handle authenticated event
AUTHENTICATED
webhook to notify your backend that the merchant account is successfully linked to Knot and that the connection status is connected
. Similarly and as applicable, listen to the client-side onEvent
callback in the SDK to receive the authenticated
event.You can also use Get Merchant Accounts to retrieve this and other merchant accounts, as well as their connection status. This can be useful to know that you should display the merchant account to the user in their list of linked merchant accounts with the appropriate connection status (i.e. connected
or disconnected
). See more about handling disconnected merchant accounts here.product.external_id
. To be notified when a product is successfully added to a cart and to receive cart information, listen to the SYNC_CART_SUCCEEDED
webhook.
delivery_location
, like you are patching the cart. You will receive fresh information regarding the cart, including the price.total
.
delivery_location
is not provided in Sync Cart and/or a delivery_location
is not provided back in SYNC_CART_SUCCEEDED
, then you cannot proceed with Checkout.products.fulfillment.id
that you received in the SYNC_CART_SUCCEEDED
webhook. You will receive fresh information regarding the cart, including the price.total
.
CHECKOUT_SUCCEEDED
webhook, which will include an array of transactions by Id
created by the checkout.
CHECKOUT_SUCCEEDED
webhook, call Get Transaction By Id for each transaction you receive (using the transaction.id
) to retrieve transaction information and subsequently enrich an order confirmation.
connection.status
in Get Merchant Accounts will be returned as disconnected
and you will not be able to make any successful requests to Sync Cart or Checkout until the user’s merchant account is reconnected. In this case, you’ll want to display a UX in your app to allow users to reconnect their account. For example, you may choose to display a button that says “Reconnect” or similarly allow the user to invoke the SDK to reconnect their account.