© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

ESS - Going Live with APIs

The hard work is done, you have an application that uses either SIMS 8 APIs, SIMS ID RAP APIs, SIMS ID One Roster APIs or perhaps a combination of them all and have a first live school in mind.

A portal based system is being developed to allow you to 'go live' with your completed integrations until then please email partner support and tell us. 

You will need to provide: a number of things:

  1. The name of your product.
  2. A short description of the product
  3. A long Product description that may include a  link to marketing details for your product
  4. A GDPR DPIA for your product (a link to your published one)
  5. A Privacy Statement for your product (a link your published one)
  6. A link which details how your customers will obtain support from you for the product.
  7. A 128x128 bitmap logo for your app 'tile'.
  8. Hex code for the tile colour
  9. Hex code for the text colour

In addition, we will need to know the scopes required by your product, do you access:

SIMS Primary / SIMS 8

SIMS ID RAP APIs SIMS ID One Roster Read APIS SIMS ID One Roster Write APIS

If so which information domains do you need access to.

Are any of these optional?

Do you use change tracking?

Required? Required? Required

 

We will assume that your application needs one set of client credentials per school unless an alternative model has been agreed (e.g. OpenID Connect and Hybrid Flow login).

 

ESS provide you with access to SIMS ID in order to create an 'Application tile'  for your application that can later be made available to schools.

School administrator (or their agent) will choose the Application tile and accept the terms, this will enable their site to be mapped to your application.

  • The system will issue Appropriate Keys and Secrets for that school to you or to the school data to flow to your application
  • Optionally you will be able to to confirm supply to that school.
    • The integrator will consider whether to accept the request and do any work required at their end. (Possible delay)
    • The integrator will confirm supply to that school. 

Once all this is complete, the school can use the integrator's product. The School, the integrator and ESS can revoke access at any time upon request from the vendor or the school.