Setting up integrations FAQ

This article covers common questions regarding the setup of integrations in Arbor. If you cannot find an answer to your query in this article, check our dedicated section of the Help Centre on this topic here.

Can we change the permissions for an API integration?

To be able to see API integrations and permissions, you'll need the:

• School: User Accounts: Administer permission on the School MIS - if you don't have the permission, you'll need to ask your admin team to give you permission using these instructions.
• User Details: Manage All Users permission on the MAT MIS - if you don't have the permission, you'll need to ask your admin team to give you permission using these instructions.

You can view an integration's current permissions by going to System > Partner Apps (API Users) > Approved Apps and clicking on the app.

It is not possible to revoke, remove, add or edit the permissions for an app from here.

• Please contact the third-party application to request a change in permissions.
• If you use a data provider such as Wonde or GroupCall, please contact the data provider. 

Please note: You won't need to re-approve the app once the changes are sent through by the third-party app.

How can we set up our own API Integration with Arbor?

To set up a new API integration with Arbor, you'll need to access our Developer Portal.

You'll find resources on setting up your integration one you're signed up, but please note that prior experience with software development and APIs is recommended.

Head to the Developers Portal at https://developers-portal.arbor.sc/login to get started.

• Third parties - Email us via api@arbor-education.com to discuss an API link.
• Schools - For more help with deciding if setting up an API is right for you, please contact the Customer Success Management Team by emailing mysuccess@arbor-education.com.

Why am I getting an Application Not Live error message when setting up API Integrations?

The 'Application Not Live' error occurs when attempting to set up third-party API integrations before the school site is live. Users should wait until their site is live to manage Partner Apps, and if the site is live but the error persists, they should contact Arbor Support or their Support Partner.

To prevent issues with data, we only allow you to set up third-party API integrations when your school site is live. If you're trying to set up API connections for the first time, you might get this message:

Application Not Live
Your Arbor MIS isn’t ready at the moment, so you can't manage Partner Apps just yet. Please try again once you’re live. If you believe this is being shown in error, please contact your Project Manager.

• If your school is not yet live, please wait until you have your final site.
• If your school is live and you're seeing this banner, please contact the Arbor Support Team if supported by Arbor, or your Support Partner if not supported by Arbor.

What is our school site's Arbor Application ID?

You might be asked to provide your Application ID to a third-party application to be able to connect via API. You can find this by going to School > School Details.

You'll need the School: General Admin: Administer permission to access this page. If you don't have the permission, you'll need to ask your admin team to give you permission using these instructions.

Why am I getting an Invalid Credentials error message when setting up API Integrations?

Some third-party apps (e.g. Hodder, Groupcall) will send you to a page to input your Arbor email and password, rather than sending a request for your approval.

When doing so, you might get one of these messages:

• 'Invalid credentials'
• 'No credentials'
• 'You are not authorized to approve apps on behalf of your school'

In these circumstances, please check the following details:

• If you’re using Two-factor authentication or Single sign-on with two-factor authentication at your school or MAT, you'll need to switch this off before you can approve new apps. Please disable two-factor authentication, approve the new apps then switch two-factor authentication back on. 
• Make sure that you have an account set up for you on each school site with the School: User Accounts: Administer permission (usually included with the School Administrator business role). MAT staff would need to be set up with a school-level account.
• You need to have logged into the school MIS account at least once and accepted the Terms & Conditions.