Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Sage 200 via a desktop application or a headless machine. For connecting via the Web, you must create a custom OAuth application to connect to Sage 200 via the Web as described here.

However, since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for use with desktop applications or headless machines anyway.

Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

Procedure

To obtain the OAuth client credentials, you must contact Sage directly:

1. Go to Sage 200 API Credentials Request Form.
2. Fill out the form to configure your custom OAuth application:
   • Specify the desired Refresh token expiry time in days. We suggest you set this to the maximum number of days, since you must initiate OAuth again once the Refresh token expires.
   • If your custom OAuth application is intended for use with a Web Application, specify a Redirect URL(s). Set this to a trusted URL where users will return after they authorize your application. Sage requires that all URLs supplied start with https.

Sage creates the desired custom OAuth application and responds with values for the OAuthClientId (Client Id), the OAuthClientSecret (Client Secret), and the Scope.

For further information, see Sage 200 API - Guide to Sage ID Changes.

Post-Procedure

The Sage 200 API is enabled by default. Any user who has been set up within the Sage Provisioning Portal as a user, and who has been assigned to a site, is automatically an API user. In order for a user to be able to query the API, all they need is a Sage ID.

For further information on how to set up and use the API for Sage 200 Standard, see How to create a user in the Sage Provisioning Portal, which includes information on how to assign a user to a site, and how to give the user company access and user access.