Introduction

OAuth 2.0 Redirect is a microservice that serves as the point of entry for user redirects and which redirects users to an appropriate brand using the information from the "state" parameter. This component can serve any application that uses the OAuth 2.0 authentication method. Currently, this is required for QuickBooks, Xero and Sage integrations.

It is not included in the CloudBlue Commerce distribution package by default and must be installed to the platform separately.

How it Works

OAuth 2.0 Redirect is installed per provider. The provider installs and configures the component on one of their CloudBlue Commerce instances, and it serves all of the provider's instances.

Example flow:

1. A reseller registered on any of the provider's CloudBlue Commerce instances installs a new integration (https://<brand-a>/psa).

2. Native Integrations generates an authentication URL.

3. Native Integrations redirects to a third-party authentication page.

4. An application redirects to the OAuth 2.0 Redirect component with parameters (https://<redirection-app>?state=<brand-a>&).
   

   Important: This redirect URL is already set up by the provider, and it must be publicly accessible.

5. OAuth 2.0 Redirect decodes parameters (FE) and redirects to <brand-a>.

6. OAuth 2.0 Redirect redirects to Native Integrations with parameters.

7. Native Integrations calls back an endpoint.

8. Native Integrations exchanges a code for an access token.

9. An application returns an access token and refreshes the token.