Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
To obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret, follow the steps below:
If you have not already done so, create an Exact Online developer account.
Log into the App Center and click Manage Apps -> Add a New Application.
Enter the app name to be displayed to users when they are prompted to grant permissions to your app.
Set the Redirect URI to a page you would like the user to be returned to after they have granted your application permissions.
Click the Edit button for your app. The client credentials, the client Id and client secret, are displayed.
Set these OAuth credentials in the datasource definition, in addition to Division and Region.
To obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret, follow the steps below:
If you have not already done so, create an Exact Online developer account.
Log into the App Center and click Manage Apps -> Add a New Application.
Enter the app name to be displayed to users when they are prompted to grant permissions to your app.
Set the Redirect URI to a page you would like the user to be returned to after they have granted your application permissions.
Click the Edit button for your app. The client credentials, the client Id and client secret, are displayed.
Set these OAuth credentials in the datasource definition, in addition to Division and Region.
QuickBooks Online uses the OAuth authentication standard. You can use the Embedded Credentials (see below) to connect without setting any connection properties. When you connect, the provider opens the OAuth endpoint in your default browser. Simply log in and grant permissions to the application. The provider then completes the OAuth process.
Alternatively, you can create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
To obtain the access token, set the following connection properties:
CompanyId: The unique identifier of a given company in QuickBooks Online.
OAuthClientId: The consumer key in your app settings.
OAuthClientSecret: The consumer secret in your app settings.
CallbackURL: The Launch URL in your app settings.
You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.
When you connect, the provider then completes the OAuth process.
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
FreshBooks uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
See below
There are two methods you can use to connect to the FreshBooks Classic API, the authentication token specific to your login or OAuth 1.0. The authentication token method is deprecated and will not be supported by FreshBooks in the future.
To connect to FreshBooks using an authentication token, specify the CompanyName and Token connection properties. The token can be found by logging in to FreshBooks and navigating to My Account > FreshBooks API.
OAuth requires the authenticating user to interact with FreshBooks using the browser. The provider facilitates this in various ways as described in the following sections.
To obtain the OAuth client credentials:
Request Developer Access through FreshBooks, if you have not already done so.
Select My Account > FreshBooks API.
Select the Use OAuth option and enter the application details. The details are displayed to users when they log in to grant permissions to the application. The OAuth consumer secret is displayed.
Note: It may take some time for FreshBooks to approve your registration.
After setting the following connection properties, you are ready to connect:
OAuthClientId: Set this to the name of the company you are connecting to. Note that you can also use the CompanyName.
OAuthClientSecret: Set this to the consumer secret in your app settings.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the access token in the connection string.
When you connect, the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the following OAuth process:
Retrieves the OAuthAccessToken and OAuthAccessTokenSecret and authenticates requests.
Refreshes the OAuthAccessToken when it expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
To obtain the access token, set the following connection properties and follow the steps below:
OAuthClientId: Set this to the name of the company you are connecting to. Note that you can also use the CompanyName property.
OAuthClientSecret: Set this to the consumer secret in your app settings.
To connect to data, set the following connection properties:
CompanyName
OAuthClientSecret
OAuthAccessToken
OAuthAccessTokenSecret
To automatically refresh the access token when it expires, set InitiateOAuth to REFRESH and set OAuthRefreshToken.
Use the OAuth 2.0 authentication standard to authenticate to the FreshBooks Alpha APIs.
OAuth requires the authenticating user to interact with FreshBooks using the browser. The provider facilitates this in various ways as described in the following sections.
To obtain the OAuth client credentials:
Log into the FreshBooks developers site at https://my.freshbooks.com/#/developer and click Create an App.
Enter information to be displayed to your users when they are prompted to grant permissions to your app.
Specify a redirect URI.
Set the redirect URI to https://localhost:33333/, or some other similar https url.
If you are making a Web application, set the Callback URL to a page on your Web app you would like the user to be returned to after they have authorized your application.
To obtain the access token, set the following connection properties:
OAuthClientId: Set this to the name of the company you are connecting to. Note that you can also use the CompanyName property.
OAuthClientSecret: Set this to the consumer secret in your app settings.
To connect to data, set the following connection properties:
AccountId
OAuthClientSecret
OAuthAccessToken
OAuthAccessTokenSecret
To automatically refresh the access token when it expires, set InitiateOAuth to REFRESH and set OAuthRefreshToken.
The provider makes requests to QuickBooks POS through the QuickBooks Gateway. The QuickBooks Gateway runs on the same machine as QuickBooks POS and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines. The first time you connect, you will need to authorize the provider with QuickBooks POS. For more information, refer to our Using the QuickBooks Gateway section below.
To work with your data in practice mode, set QBPOSPractice. Additionally, set QBPOSVersion.
Follow the steps below to authorize with QuickBooks POS and connect to a company file when both QuickBooks POS and the provider are running on your local machine.
Open QuickBooks POS as an administrator and open the company file you want to connect to.
Connect to QuickBooks POS. A dialog will appear in QuickBooks POS prompting you to authorize the provider. After granting access to the provider, you can now execute commands to QuickBooks POS.
If you want to connect to the company file when QuickBooks POS is closed, set the CompanyFile connection option when you execute commands. QuickBooks POS will open automatically in the background with the file specified.
Note that if QuickBooks POS is open through the application UI, only that CompanyFile can be used.
If you receive a connection error (such as "Internal error 160002") you may need to switch QuickBooks POS to multiuser mode. This is done by selecting the "Switch Company File to Multi User Mode" option in the File Menu. You should then be able to connect to the company file.
If a CompanyFile is not specified in the connection string, QuickBooks POS may present an "Enter Company Name" window the first time you connect. In this window, you must specify the company file and the computer name where the company file is located.
The QuickBooks Desktop Gateway can be used to read and write to QuickBooks POS in situations where direct COM access to QuickBooks POS is not available (e.g., ASP.NET, Java, or QuickBooks POS on a remote machine). Follow the procedure below to connect to QuickBooks POS for the first time through the Desktop Gateway:
If you have not already done so, download the QuickBooks Desktop Gateway from here and install it.
Open the company file you want to connect to in QuickBooks POS using an administrator account in single-user mode.
Open the QuickBooks Desktop Gateway from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The QuickBooks Desktop Gateway does not use the User and Password properties to access QuickBooks POS; the User and Password properties authenticate the user. Authentication to QuickBooks POS is handled by the ApplicationName property.
When you first connect, a dialog appears in QuickBooks POS prompting you to authorize the application. After authorizing, you can execute commands to QuickBooks POS. Specify the URL of the Desktop Gateway and the User and Password. By default, the Gateway connects to the currently open company file.
If you want to access QuickBooks POS when QuickBooks POS is not running, save the company file information for the user. The Desktop Gateway automatically opens QuickBooks POS in the background with the company file for that user.
NOTE: that if the QuickBooks POS UI is open, you can only connect to that company file. Additionally, the user permissions you specify for the Desktop Gateway must match the user permissions you used for QuickBooks POS. The Desktop Gateway installs as a service in the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the provider. You can do so by setting the SSLServerCert property.
The provider makes requests to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines. The first time you connect, you will need to authorize the provider with QuickBooks.
The Remote Connector can be used to read and write to QuickBooks in situations where direct COM access to QuickBooks is not available (e.g., ASP.NET, Java, or QuickBooks on a remote machine). Follow the procedure below to connect to QuickBooks for the first time through the Remote Connector:
If you have not already done so, download the Remote Connector from remoteconnector.com and install the Remote Connector on the machine where QuickBooks is installed.
Open the company file you want to connect to in QuickBooks using an administrator account in single-user mode.
Open the Remote Connector from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The Remote Connector does not use the User and Password properties to access QuickBooks; the User and Password properties authenticate the user to the Remote Connector. Authentication to QuickBooks is handled based on the ApplicationName property.
When you first connect, a dialog will appear in QuickBooks prompting you to authorize the application. After authorizing the application, you can then execute commands to QuickBooks. Specify the URL of the Remote Connector and the User and Password. By default, the Remote Connector connects to the currently open company file.
If you want to access QuickBooks when QuickBooks is not running, save the company file information for the user. The Remote Connector will then automatically open QuickBooks in the background with the company file for that user.
Note that if the QuickBooks UI is open, you can only connect to that company file. Additionally, note that the user permissions you run the Remote Connector under must match the user permissions you run QuickBooks under. The Remote Connector installation process installs the Remote Connector as a service under the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the provider. You can do so by setting the SSLServerCert property.
Follow the steps below to authorize with QuickBooks and connect to a company file when both QuickBooks and the provider are running on your local machine.
Open QuickBooks as an administrator and open the company file you want to connect to.
Connect to QuickBooks. A dialog will appear in QuickBooks prompting you to authorize the provider. After granting access to the provider, you can now execute commands to QuickBooks.
If you want to connect to the company file when QuickBooks is closed, set the CompanyFile connection option when you execute commands. QuickBooks will open automatically in the background with the file specified.
Note that if QuickBooks is open through the application UI, only that CompanyFile can be used.
Sage Business Cloud Accounting uses the OAuth standard to authenticate users.
OAuth requires the authenticating user to interact with Sage Business Cloud Accounting using the browser. The provider 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
You can connect without setting any connection properties for your user credentials. Set InitiateOAuth to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Log into Sage accounting Developer Account.
Create a new app. Set the CallbackUrl to http://localhost:3333, or some other similar http url.
The OAuthClientId is the Client Id displayed. The OAuthClientSecret is the Client Secret.
To connect to Web Services, you will first need to enable the Web Services subscription. Navigate to Company > Admin Tab > Subscriptions and enable Web Services.
Intacct also recommends creating a Web Services-only user, which can be done by navigating to Company > Admin Tab, and clicking on the + sign beside Web Services users.
You can establish a connection to Sage Intacct with your own credentials.
To authenticate, set CompanyID and set User and Password to the credentials you use to log on to Sage Intacct. In addition, you will need to either set your own SenderID and SenderPassword.
You can use your own Web Services credentials to write data to Intacct. Set the following to connect to data:
SenderID: Set this to the Web Services Sender ID assigned to you by Sage Intacct.
SenderPassword: Set this to your registered Web Services password.
Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:
User: Set this to the Okta user.
Password: Set this to Okta password for the user.
SSOLoginURL: Set this to the login url used by the SSO provider.
The following SSOProperties are needed to authenticate to Okta:
IntacctUserID: Set this value to the Intacct User ID that is mapped to the Okta user you set in the User connection property.
APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides Okta client request context.
The following is an example connection string: AuthScheme=Okta; SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46'; User=oktaUserName; Password=oktaPassword; SSOProperties='IntacctUserID=intacct_user';
The first time you connect, you will need to authorize the provider with Reckon. The provider makes requests to Reckon through the Remote Connector. The Remote Connector runs on the same machine as Reckon and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.
Follow the steps below to authorize with Reckon and connect to a company file when both Reckon and the provider are running on your local machine.
Open Reckon as an administrator and open the company file you want to connect to.
Connect to Reckon. A dialog will appear in Reckon prompting you to authorize the provider. After granting access to the provider, you can now execute commands to Reckon.
If you want to connect to the company file when Reckon is closed, set the CompanyFile connection option when you execute commands. Reckon will open automatically in the background with the file specified.
Note that if Reckon is open through the application UI, only that CompanyFile can be used.
The Remote Connector can be used to read and write to Reckon in situations where direct COM access to Reckon is not available (e.g., ASP.NET, Java, or Reckon on a remote machine). Follow the procedure below to connect to Reckon for the first time through the Remote Connector:
If you have not already done so, download the Remote Connector from remoteconnector.com and install the Remote Connector on the machine where Reckon is installed.
Open the company file you want to connect to in Reckon using an administrator account in single-user mode.
Open the Remote Connector from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The Remote Connector does not use the User and Password properties to access Reckon; the User and Password properties authenticate the user to the Remote Connector. Authentication to Reckon is handled based on the ApplicationName property.
When you first connect, a dialog will appear in Reckon prompting you to authorize the application. After authorizing the application, you can then execute commands to Reckon. Specify the URL of the Remote Connector and the User and Password. By default, the Remote Connector connects to the currently open company file.
If you want to access Reckon when Reckon is not running, save the company file information for the user. The Remote Connector will then automatically open Reckon in the background with the company file for that user.
Note that if the Reckon UI is open, you can only connect to that company file. Additionally, note that the user permissions you run the Remote Connector under must match the user permissions you run Reckon under. The Remote Connector installation process installs the Remote Connector as a service under the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the provider. You can do so by setting the SSLServerCert property.
The provider connects to Sage 50 UK data through the SData REST API included in the Sage 50 UK installation. SData allows access to local company datasets as well as datasets on network drives.
After Configuring the Sage SData Service, connect with the below steps, the URL property should be set to the address of the company dataset desired. To obtain the address, do the following:
If you have not already done so, open the Sage 50 UK software.
Select Tools > Internet Options .
Select the Sdatasettings tab.
Click Details next to the Sage 50 software application you want to connect to. A window opens containing a list of company names along with the addresses to their corresponding datasets.
Set the URL property to the value in the address field next to the company desired.
The User and Password properties must be set to valid Sage 50 UK user credentials. These values are the same values used to log in to the Sage 50 UK software. To authenticate with HTTP digest to the SData service, set AuthScheme to Digest. Otherwise, Basic AuthScheme will be used.
Note: If the dataset you want to connect to is not displayed, the permissions on the Sage 50 UK folder location may not be correct. If you are connecting to a dataset on a networked drive, ensure:
You are using UNC paths to the folder on the machine you are using as your SData provider.
You set the SData service login rights to a user who has full rights over the network share or map drive.
The Provider for Sage 50 UK connects to Sage 50 UK via the Sage SData service (which is Sage's Web toolkit for connecting to Sage instances) that is built into the Sage 50 UK software. SData allows for remote access to Sage software applications. By default, Sage UK 2015 instances will have SData turned on and ready for use.
You can follow the steps below to verify that the SData service is started.
If you have not already done so, open Sage 50.
Navigate to Tools > Internet Options. The Internet Options window is displayed.
Select the Sdatasettings tab. A list is displayed of Sage software applications that are currently available.
To turn the SData service on for the application, select the On option.
If the SData Service Status does not read "SData is currently running", click the Advanced button.
In the dialog that is displayed, specify the Port Number desired when making the connection and click the Restart button.
If the Windows Firewall button is enabled, click this button to unblock the port. If you have any additional firewalls on the machine, ensure that they are configured to allow connections to be made on the specified port number.
Once you apply any changes, you can then establish a connection to your Sage 50 UK software.
The Sage SData service provides secure and encrypted connections via HTTPS. Data confidentiality and the authenticity of the server are provided by digital certificates. If you do not have a certificate, use IIS to generate a self-signed certificate.
You can follow the steps below to configure the SData service to use a certificate; the provider will validate this certificate against the system trust store by default. If you generated a self-signed certificate, you can add the certificate to this certificate store or set SSLServerCert.
The certificate has the following requirements:
The certificate must have a full valid trust chain.
The common name (CN) for the certificate must match the machine/domain name where the SData service is running. To ensure that the CN is correct, generate the self-signed certificate on the machine where Sage 50 SData is running.
The certificate must be added to the personal My certificate store for the Local Machine account.
You can then configure the SData service to use the certificate:
Navigate to C:\Program Files (x86)\Common Files\Sage SData and open Sage.SData.Service.Config.UI.exe.
Click the Advanced button. The SData Configuration window is displayed.
Select the Enable HTTPS Access option and select the port desired.
If you have any firewalls on your machine, make sure the ports specified are not blocked.
Click the button next to the Certificate box.
In the resulting dialog, select the certificate.
If you select a certificate and do not see the certificate name populated in the Certificate textbox, this is most likely due to missing extended properties within the certificate. The extended properties include thumbprint, thumbprint algorithm, key usage, and enhanced key usage.
Use IIS to avoid this issue: IIS automatically populates these fields when generating a self-signed certificate.
Click OK to restart the server.
Verify that the Enable HTTPS option is selected in the SData configuration window.
If the SData configuration window is closed and reopened but the Enable HTTPS option is not enabled, this is most likely caused by the Sage.SData.Service.exe.config file not being updated properly. Follow the steps below to use the alternate configuration file below.
You will need the certificate thumbprint. Note that the thumbprint data includes spaces. The thumbprint data can be obtained using Windows services. You can also access the thumbprint in the SData configuration window:
If you have not already done so, open the Sage.SData.Service.Config.UI.exe application and open the advanced settings.
Click the button next to the Certificate box.
In the Windows security dialog, click "Click here to view certificate properties". The Certificate Details window is displayed.
On the Details tab, copy the value in the Thumbprint field.
Use this value in the CertificateLookupValue setting in the configuration file. For example:
<?xml version="1.0" encoding="utf-8" ?><configuration><configSections><sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" ><section name="Sage.SData.Service.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /><section name="Sage.Integration.Server.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /><section name="Sage.Common.Syndication.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /></sectionGroup></configSections><applicationSettings><Sage.SData.Service.Properties.Settings><setting name="DigestTimeout" serializeAs="String"><value>12000000000</value></setting><setting name="EnableBasicAuthentication" serializeAs="String"><value>True</value></setting><setting name="WebAppPath" serializeAs="String"><value /></setting><setting name="EnableSSL" serializeAs="String"><value>True</value></setting><setting name="Port" serializeAs="String"><value>443</value></setting></Sage.SData.Service.Properties.Settings><Sage.Integration.Server.Properties.Settings><setting name="EnableBroadcast" serializeAs="String"><value>False</value></setting></Sage.Integration.Server.Properties.Settings><Sage.Common.Syndication.Properties.Settings><setting name="IPAddress" serializeAs="String"><value /></setting><setting name="Server" serializeAs="String"><value>sdata</value></setting><setting name="EnableSSLPort" serializeAs="String"><value>True</value></setting><setting name="Port" serializeAs="String"><value>5493</value></setting><setting name="SettingsProviderType" serializeAs="String"><value>Sage.Common.Syndication.ConfigurationSyndicationSettings, Sage.Common.Syndication</value></setting><setting name="PathPrefix" serializeAs="String"><value /></setting><setting name="DoNotUseRegistry" serializeAs="String"><value>False</value></setting><setting name="EnableStandardPort" serializeAs="String"><value>True</value></setting><setting name="SSLPort" serializeAs="String"><value>5494</value></setting><setting name="CertificateLookupValue" serializeAs="String"><value>ENTER YOUR CERTIFICATE THUMBPRINT HERE</value></setting><setting name="CertificateLookupType" serializeAs="String"><value>Thumbprint</value></setting></Sage.Common.Syndication.Properties.Settings></applicationSettings></configuration>
The provider supports the following Xero APIs:
Accounting API: Set the Schema connection property to ACCOUNTING
Australian Payroll API: Set the Schema connection property to PAYROLLAUS
Files API: Set the Schema connection property to FILES
Fixed Assets API: Set the Schema connection property to ASSETS
Projects API: Set the Schema connection property to PROJECTS
By default the provider authenticates to Xero using OAUTH2
You will need to create an OAuth application and set InitiateOAuth to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
Follow the steps below to register a public application and obtain the OAuthClientId and OAuthClientSecret.
Log in to the Xero developer portal.
Click My Apps -> Add Application. Choose the Auth Code application type.
Enter a name for your application and the URL of your company. This information is displayed to users when they connect.
Set the Redirect URI to the full redirect or callback URL, where the user returns with the token that verifies that they have granted your app access.
When connecting using OAUTH2, Xero grants the provider access to all of the organizations that the user has authorized. By default the provider will connect using the first available organization. Since this default changes as you authorize new organizations, it is recommended that you set the Tenant connection property to ensure future connections always use the same organization.
The Tenant property can be set to either the name or ID of a Xero organization.
The Xero API has usage limitations that may be encountered while using the Provider for Xero.
There is a daily limit of 5000 API calls against a single Xero organization in a rolling 24-hour period.
In addition to the daily limit, a single access token can only be used up to 60 times in a rolling 60-second period.
If you encounter a rate limit, the Xero API will return an HTTP 503 (Service Unavailable) error, with the following message: "oauth_problem=rate limit exceeded".
Note: If you encounter a rate limit, do not continue to make requests, as this may continue to add to your limitation. If necessary, you may need to queue requests.
When working with the provider, some operations may result in multiple requests to the API. For example, updating an existing record will result in two requests: one to get the current record, and one to submit changes.