Introduction
This guide will walk you through the process of setting up OAuth for ExactOnline, helping you integrate this powerful tool with your existing systems. Whether you’re a developer or an IT administrator, follow these steps to simplify authentication and ensure a secure connection to ExactOnline’s APIs. Let’s get started!
Steps
Step 1: Navigate to the Integration Builder in Workspace 365
Log in to Workspace 365.
Go to the Integration Builder via the menu or the settings page.
Click on the Authentication tab at the top of the page.
Then click the New button to create a new authentication.
Step 2: Select the OAuth2 type and enter a name
After clicking New, a window will appear to configure the authentication.
In the Type field, select the OAuth2 option from the available choices.
In the Name field, enter a recognisable name. For this guide, we will use:
OAuth2 ExactOnlie Authentication.
Step 3: Log in to the ExactOnline App Store
To begin integrating your application with ExactOnline, you need to access the ExactOnline App Store. Follow these steps to log in:
Navigate to the ExactOnline Login Page:
Open your web browser and search for the ExactOnline login page.Enter Your Credentials:
Input your ExactOnline username and password in the respective fields.Authenticate:
Click on the 'Login' button to access your account.
Step 4: Register Your Application
Once you have logged into the ExactOnline App Store, follow these steps to register your application:
Initiate App Registration:
Click on the 'Register a new app' button to begin the registration process.Provide App Details:
Name: Enter a unique name for your application to identify it. for this integration we will use "Workspace 365 integration"
Redirect URI: Enter the Redirect URI provided by Workspace 365. This URL is essential for the integration and can be found within your Workspace 365 environment. Ensure it is entered exactly as provided.
Review and Accept Terms and Conditions:
Carefully review the terms and conditions and check the box to accept them.Submit Your Registration:
Click the 'Register' button to finalise the process.
After completing these steps, you will receive a Client ID and Client Secret, which are critical for integrating your application with ExactOnline.
Step 5: Retrieve and Enter Client Credentials
After registering your application, you will be directed to an overview page of the newly registered app. Follow these steps to find and use your Client ID and Client Secret:
Navigate to 'Develop Your App':
On the overview page, locate and click on the 'Develop Your App' tab.Find the Client Credentials:
Here, you will see the Client ID and Client Secret. These credentials are necessary for integrating ExactOnline with Workspace 365.Copy the Client ID and Client Secret:
Carefully copy both the Client ID and Client Secret from this page.Enter the Credentials in Workspace 365:
Go to your Workspace 365 environment and paste the Client ID and Client Secret into the appropriate fields under the designated sections. Ensure that you paste them accurately to avoid any integration issues.
With these credentials entered, you are one step closer to completing the OAuth setup for ExactOnline within Workspace 365.
Step 6: Configure Authorization and Token Endpoints
To complete the integration, you need to configure the Authorization and Token endpoints in Workspace 365. Follow these steps:
Locate the Endpoint Configuration Section in Workspace 365:
In Workspace 365, navigate to the section where the API integration settings for ExactOnline are configured.Enter the Authorization Endpoint URL:
Copy the following URL:
https://start.exactonline.nl/api/oauth2/authPaste this URL into the Authorization Endpoint URL field.
Enter the Token Endpoint URL:
Copy the following URL:
https://start.exactonline.nl/api/oauth2/tokenPaste this URL into the Token Endpoint URL field.
Save the Configuration:
Once both URLs have been entered, ensure you save the settings to apply the changes.
These endpoints allow Workspace 365 to communicate securely with ExactOnline, facilitating the OAuth authentication process.
Step 7: Authenticate and Complete the Setup
After saving the configuration, follow these steps to complete the OAuth authentication process:
Authenticate:
Click on the Authenticate button that appears in the popup.
A new ExactOnline authentication window will open.
Sign In to ExactOnline:
Enter your ExactOnline credentials in the login screen that appears.
Follow the prompts to complete the authentication process.
Confirm Successful Authentication:
If the authentication is successful, you will see an Authentication Successful message.
Close this window.
Finish the Setup:
Click the Finish button in Workspace 365 to finalise the integration process.
Important Notes:
If the app is for internal use only, there is no need to define a specific scope. Instead, permissions are inherited directly from ExactOnline.
Optionally, within the Integration Builder in Workspace 365, you can specify which groups or users are allowed to access the integration. This ensures that only authorised users have access to the integrated functionality.
Congratulations! You have successfully completed the OAuth authentication setup for ExactOnline within Workspace 365. Your integration is now ready to use.
