Getting Started with your Assembly Sandbox Account
Please don’t hesitate to get in touch if you have questions. You can email us at email@example.com or give us a call at 020 8506 6100.
You can sign up to your own Sandbox environment here.
Enter your name, email, company and create a password:
If you have been invited to the Platform, you will receive an email invitation - click the Accept invitation link to reach the above page. You will not have to enter a company.
You'll then be sent a confirmation email to the address you provided.
Click the link in the email to confirm your account.
You're now successfully signed up!
Adding an app
To create an app, click the New Sandbox App button.
Give the app a Name and, if you like, a description.
The Redirect URI and Install URI boxes relate to implementation of the OAuth flow. If you want to configure your app for OAuth now, please see this support article. If you are just testing the API, you can enter anything here for the time being.
Ensure the List this App for other schools to find? tick box is highlighted and click Create App to finish the process.
IMPORTANT: When you click the Create App button you'll be given a
client_secret. You must make a note of these now. This is the only time you will be able to see this information.
Inviting other users (optional)
From the Users menu item on the left, you can invite other users to join your company.
Click Invite User then enter their email and hit Send Invitation.
Adding your Test School
Go to the Test Schools area and click Add Test School to generate your simulated school data.
You can click on the name of the school to get taken to the Platform "school view" - from here you'll be able to see and authorise your app as if you were a school.
Getting a school access token
Now that you have a test app and a test school, you can manually generate an access token which can be used to query our API.
Find the app you want to create a token for and select it, then go to Credentials on the left hand side, and scroll down to the New School Token button:
You'll then be given an
refresh_token. Make a copy of the information.
Calling the API
You can then provide this school
access_token, preceded by "Bearer ", as an
Authorization HTTP Header in your requests to https://api-sandbox.assembly.education.
You will also need to provide an
Accept header of "application/vnd.assembly+json; version=1", as below:
Please note: before your app is ready to go live you will need to implement the Assembly Platform OAuth flow in order to gain access to a school's data.
For more information on how to do this, please see this support article. If you are just testing the API, you can skip this step for now - but you must complete it at a later date.
If you have any questions about the above please contact firstname.lastname@example.org.