This page is a reference for advanced application integration topics

Custom Integration Credentials

For OAuth based application integrations you may specify your own “app” credentials if you are a developer that has created your own app within a given providers development portal.

To obtain and configure integration credentials we will go to https://admin.myintranetapps.com/app/integration-config-overrides.php

Obtaining Credentials

For each OAuth based app you will need to access the developer portal of the relevant provider, links for these developer portals are provided via a list of integrations on the App Credentials page.

The link will take you to a sign up page for the provider where you will generally be required to agree to terms and conditions and privacy policies - it is important to read these as they will govern your use of the providers API.

Once you are signed in to the providers developer portal you will create an “App”, which is a way of identifying your use of the API from others, this App will provide you with an identifier and secret key which you will need to copy in to the App Credentials page as described below.

Quickbooks Example

1. Create Account (5 mins) Head over to https://developer.intuit.com/ and click “Sign Up”. Follow Intuit's steps to open an account

2. Create App (5 mins) Now that you have an account go to https://developer.intuit.com/app/developer/dashboard , you should see a “Create an app” button.

Click the “Quickbooks Online and Payments” button

Next you will give your app a name, typically this would be your business or service offering name. It will appear to your customers when they connect. Because we are only interested in Accounting data we will check the “com.intuit.quickbooks.accounting” scope, a scope indicates the breadth or depth of data you need access to. Some integrations are very fine grained in how their scopes are defined while others are at a higher product level.

The App is now created

3. Agreements (10-30 mins) Click on “Keys & OAuth” under the Production menu in the side menu.

A configuration page for your app is shown where you can adjust links, logo and categorize your app.

After saving the configuration page for your app click on “Keys & OAuth” under the production menu again. You Client ID and Client Secret are displayed, this is information needed in the subsequent “Configuring Credentials” step below. The last step is to add Redirect URIs, click the “Add URI” button and enter either:

Noting that the .com address is used if your data with us is resident in the US and the .ca if it is resident in Canada.

Your App is now done and your credentials are ready to be added at https://admin.myintranetapps.com/app/integration-config-overrides.php

Spotify Example

1. Create Account

Head over to Shopify Partners and click “Join now”. Follow Shopify's steps to open an account

2. Create App

Now that you have an account, login to Shopify Partners, click “Apps” in the left sidebar, then click the “Create app” button.

Select the “Public app” option, and give your app a name and URL. Typically the app name would be your business or service offering name, and the URL would be your website. These will be displayed to your customers when they connect.

Scroll down and add the following two URLs the the “Allowed redirection URL(s)” section, with each URL on a separate line. Then click the “Create app” button in the top right to finish creating your app.

3. Submit App for Review

The app is now created and must be reviewed by Shopify before it can be used. To submit it for review, click “Apps” in the left sidebar, and click your app name in the list of apps.

Then, click “Create listing”.

Click “English listing”, fill out the form, and click “Save” at the bottom.

Return to the app listing page and click “Submit app” to complete your app submission.

Once your app has been approved by Shopify, your credentials are ready to be added at https://admin.myintranetapps.com/app/integration-config-overrides.php

The credentials you will need are the “API key” and “API secret key” from the app details page. The “API key” is your app “identifier” and the “API secret key” is your app “secret”.

Configuring Credentials

On the App Credentials page enter the unique key of the integration you want to provide credentials for. e.g. for Quickbooks the key is quickbooks

Next you will need to select the environment for the override, this is typically either Sandbox or Production

You will need your app identifier (aka Client ID) and secret (aka Client Secret) and you will need to place these two pieces of information in JSON notation e.g.

{
  "identifier":"XXXXX",
  "secret":"YYYYY"
}
JSON

Where XXXXX is the unique identifier of your app and YYYYY is the app secret.

Some integrations may require more than these two pieces of information, if so it is noted in the credentials UI.

Switching an Account Environment

The environment an account operates in can be temporarily overridden. Go to https://example.myintranetapps.com/integrations-advanced.php (where “example” is your subdomain name)

This is typically used to switch an account from using Production API credentials to Sandbox and vice-versa and can be helpful during a testing and setup phase.

Some integrations exhibit different behaviours when switching between Sandbox and Production modes and may limit or modify functionality. e.g. Quickbooks in a Sandbox environment will only allow the connection of Sandbox accounts, Stripe in Sandbox environment will only allow access to Test data. Refer to the 3rd party provider for details on any documented differences.