Skip to main content

API Sandbox

To aid you with exploring the value you can add to your application with Xporter, we offer a sandbox environment with demonstration schools.

An API sandbox is a testing environment that allows you to test your application against the Xporter API without using real school data. The demonstration schools available on the sandbox provide a replica of live API functionality with fake data. This allows gives you the opportunity to experiment and try out new ideas without worrying about breaking anything or impacting your production application.

Accessing the Sandbox​

You can visit the API sandbox by visiting https://xporter.groupcall.com/TryIt

From here you will be prompted to provide some details to authenticate before you can access API endpoints

Authenticating with the Sandbox​

During application registration you will have been provided API details for two schools:

  • DfE Number: 3281102 - a secondary school

  • DfE Number: 3281101 - a primary school

tip

Both of these schools are utilising demostration data from the SIMS MIS, for the current academic year

On the sandbox page you will be prompted for the following pieces of information:

  • Relying Party Id: Your Application Id, entered during registration
  • School Estab Code: The school's DfE number
  • App Estab Secret: The school specific secret issued to you
tip

For the two demo schools, the secret you have been issued is the same. Production schools will all have unique secrets

  1. Enter the information provided into the Obtain a token from Xporter STS form
  2. Click Get Token

A token will be generated and you will see all of the endpoints appear in the left hand navigation pane.

Using the Sandbox​

You can now try out each of the endpoints available on the Xporter platform for accessing school data.

You can review how the request was constructed, how to add parameters and options including how changing them affects the output of data.

You will receive real responses from the API that you can expect your application to receive and view them in either JSON or tabular format.

Each endpoint may have its own options and parameters that you can set and experiment with.

Check out the Concepts section for more detail on parameters, options, pagination, callbacks and more.