OAuth 2.0

OAuth 2.0

You can embed Ecart API's OAuth flow so your customer connects their store without leaving your experience.

OAuth URL

  1. Send your customer to the OAuth URL for your app. The APP_ID is the one from your dashboard.
  2. OAuth URL (example): https://oauth.ecartapi.com/[APP_ID]?nobar=true
    You can embed this URL in your site (e.g. iframe or redirect). Replace [APP_ID] with your app's ID.

Steps for your customer

StepAction
1Enter their store name and/or URL.
2Click continue to start the OAuth process.
3The ecommerce platform asks the store owner to authorize. After authorization, the customer is redirected to the Redirect URL you set when creating the app.

What you get in the redirect URL

The redirect URL is called with query parameters including access_token, ecommerce, url, name, token, refreshToken, userId, and ecartapi_key. See Store authentication for the full list and how to validate the request with ecartapi_key.

Next

Store access token — Saving and using the access token.
API endpoints — API versions and base URL.