Skip to main content

App Registration

App registration is the process of registering your application with the Xporter API. You will need to register an account with the Xporter platform, where you will then be issued with API secrets and demonstration schools to develop against. Once registered, you can use the Xporter API's rich collection of school data APIs to fetch data.

Register your application​

To begin, you will need to provide us some information about your application.

  1. Navigate to the application registration form: https://manage.groupcall.com/XodRegister/Partner

  2. Enter your contact details

  3. Enter an identifier for your application

tip

Typically this would be the hostname or a subdomain of your application, for example: datasync.educationapp.com

  1. Enter the display name for your application
tip

Your customers will see this when approving data sharing requests or checking the Xporter Portal

  1. Provide a https URL to a logo image that we can display in the Xporter Portal and co-branded emails sent by the platform
Optimal Dimensions

The aspect ratio of the logo should be TODO to appear properly

  1. Leave the authorisation URL blank for now
tip

We will come back and populate this later via your application settings in the Xporter Portal

  1. Enter a link to your Data Sharing Agreement for use during data authorisation processes
tip

You can also leave this blank for now. It will be required before you can begin to onboard real schools

  1. Click Submit

  2. You will now be sent an email to validate your email address. Complete email validation and your application registration will be submitted to the Xporter accounts team who will review and verify your details.

  3. Once verified, you will receive another email with a link to collect your application credentials

Important!

Make sure to securely record the information you are provided with, you will need it to authenticate your application with the Xporter API and access demonstration school data.