Using OAuth Authentication
OAuth requires the authenticating user to interact with Sage Business Cloud Accounting using the browser. The driver facilitates this in various ways as described below.
Note: The driver makes use of the Sage Business Cloud Accounting API (v3.1) to connect. The supported countries for this API version are:
- Canada
- Germany
- Spain
- France
- United Kingdom
- Ireland
- United States
Embedded Credentials
See Embedded Credentials to connect with the driver's embedded credentials and skip creating a custom OAuth app.Custom Credentials
Instead of connecting with the driver's embedded credentials, you can register an app to obtain the OAuthClientId and OAuthClientSecret.
When to Create a Custom OAuth App
Web Applications
You need to create a custom OAuth app in the web flow.
Desktop Applications
Creating a custom OAuth app is optional as the driver is already registered with Sage Business Cloud Accounting and you can connect with its embedded credentials. Create a custom OAuth app in the following scenarios:
- If you need to request additional permissions over the driver defaults.
- If you want to change the information displayed when users log into the Sage Business Cloud Accounting OAuth endpoint to grant permissions to the driver.
Creating a Custom OAuth App
See Creating a Custom OAuth App for a procedure.