API Users management process (CPOMS, Wonde, Inventry etc.)

Please note: Arbor’s process to connect to apps requires you to contact the app's company directly before any integration can take place, regardless of whether the app is one of our current partners or not. For more information, see the section entitled ‘Connecting with new apps’.

The way we connect with 3rd party apps e.g. Inventry, Wonde etc. gives you the ability to easily manage apps that can access your school’s data. For each app, you can inspect what data it uses, what it can do with this data, and easily manage the apps that can access your school’s data. 

If you are not happy with the data an app is requesting or would like to find out more about how and why this data is being used, please contact the app’s company directly.

 

Some apps you can connect to using the process:

  • EntrySign
  • Ami Education/Gladstone
  • Wise Pay (via Wonde)
  • Class Charts (via Wonde)
  • Biostore (via Groupcall)
  • B Squared
  • Classroom Monitor (via Wonde)
  • Chatter
  • CPOMS
  • Groupcall
  • GCSEPod (via Groupcall)
  • Hegarthy Maths (via Wonde)
  • Inventry 
  • Live Register
  • Teachers 2 Parents (T2P)
  • Salamander
  • School Booking
  • Show My Homework (via Groupcall)
  • Wonde
  • PrimarySite

 

Connecting with new Apps

If you know the app is one of our current partners, please contact the app's company directly to let them know you would like to work with them. They will set up the new connection. 

If the app is not one of our current partners, or you're not sure, please let us know the name of this app, and contact the app's company directly to let them know you would like to work with them.

We will let you know if the app is a partner, and will ask you some additional questions about why you want to connect with this app to help us decide whether we would like to establish a connection with the app. If we do, we will work with the app's company to try and get you connected. The app will need to contact us by emailing hello@arbor-education.com or api@arbor-education.com to begin the integration process.

Please note that our API is only available to apps that are not competitors to our products and that the process of making a connection can take some time, as the app will need to build their part of the integration before connecting.

 

When the connection has been established, you will be notified within Arbor that there is a pending request that requires your attention. You will have to navigate to System> Partner Apps (API Users) and approve the request for it to be able to access your school’s data.

For each 3rd party app that wants to connect, or is already connected with your school's data, you can:

  • View the details of what data the app is requesting access to or already uses
  • Approve the app
  • Reject the app

An explanation of key terms can be found at the bottom of the page.

To view an app that is trying to connect with your school, select Pending requests from the left-hand menu.

Screen_Shot_2018-09-24_at_16.27.39__1_.png

 

Click the row containing the app in question and you will be presented with a slide-over showing the permissions requested.

Screen_Shot_2018-09-24_at_16.08.52.png

 

In this example, an app is requesting to be able to view and update all the data within the ‘Staff’ module, shown by ticks. However, it cannot delete the data, shown by a cross in the table. This means the app cannot create data, or delete any data that is in Arbor regarding staff.

If you are happy with the access the app is requesting, you can confirm the access of the 3rd party app by clicking Approve. If you do not want an app to access the data, click Reject.

Top tip: You can download a list containing all the data the app is using or has requested to use. Helpful if parents are wondering what information about their child is available to partners!

 

Alternative Connection Option

Some 3rd party Apps that have already established a connection with Arbor may offer you an alternative way of integrating with your MIS site. Using this method, there is no need for the app to send a request for your approval on the System > Partner Apps (API Users) page.

You will be sent a link by the App's developers where you should input your Arbor credentials (the email and password associated with your Arbor MIS account). After authorization, you will be able to check what data the App will be able to access and approve this. Your school will then be connected to the app, and the app will appear as an Approved app on the System> Partner Apps (API Users) > Approved Apps page. 

If you ever need to reject the connection, follow the instructions in the section below. 

 

Managing existing connections

If you would like to revoke access or are no longer using an app, you can reject an app. This will immediately prevent it from using and accessing your school's data. To do this:

  1. Click the Approved Apps tab
  2. Select the app name
  3. Click the Reject button
  4. The app will then move to your Rejected Apps list

Screen_Shot_2018-09-24_at_16.31.26__1_.png

 

You can also give access to an app you previously rejected. This will immediately enable the app to use and access your school's data. To do this:

  1. Click the Rejected Apps tab
  2. Select the app name
  3. Click the Approve button
  4. The app will then move to your Approved Apps list

Screen_Shot_2018-09-24_at_16.33.15__1_.png

 

Key definitions

Data type- The group of data the app can access e.g. if an app can access the ‘staff’ entity, this could include staff name, contract details, timetables, etc.

Specific fields- What specific pieces of data the app will be able to access e.g. it may be able to access all data regarding staff, or perhaps only staff attendance.

Read- App can access this data e.g. a timetabling app can see what lesson a staff member is teaching next

Write- App can create this data e.g. an app can add new staff members

Update- App can edit data e.g. app can be used to update staff details

Delete- App can delete data e.g. app can delete a staff member

 

If you are not happy with the data an app is requesting or would like to find out more about how and why this data is being used, please contact the app’s company directly. 

I'm still stuck!
0 out of 0 found this helpful