Sandbox
Sandbox console Send a request to the API from this page and see exactly what comes back. Every request goes to the sandbox, https://apisnd.main-team.org, with sandbox accounts and data. Production is never called from here.
Before you send 01
Get a sandbox account Sandbox credentials are separate from production ones and work only in the sandbox. Ask for them at info@main-team.org . How the sandbox differs
02
Sign a token on your machine Sign a short-lived token with your sandbox API key and secret, then paste the token below; the console has one-line commands for Node.js and PHP. Never paste your API secret: the console refuses it. Signing a token
03
Choose an endpoint and send What you create stays in the sandbox. To test a payment, pay in the sandbox panel with Stripe’s test cards .
Endpoint GET · Check that the API is up POST · Revoke the token you send, before it expires GET · Fetch the API account your token belongs to GET · List the countries a student can be registered in GET · Fetch one country by its id GET · List the grades a student can be registered with GET · Fetch one grade by its id GET · List the organizations and their ids GET · Fetch one organization by its id GET · List your students POST · Register a student POST · Check a registration without registering the student POST · Register many students at once GET · Follow a batch of students you sent GET · Fetch one of your students PUT · Update one of your students PUT · Set the sign-in password of one of your students GET · List your students who can use this organization GET · Fetch one of your students, if they can use this organization PUT · Update one of your students and give them access to this organization PUT · Link one of your students to a supervisor on this organization POST · Create a single-use sign-in link for one of your students GET · List the exams open for applications GET · List an organization’s exam categories GET · Fetch one exam category GET · List the exams one of your students can apply to GET · Fetch one exam that is open for applications GET · List your students’ applications in this organization POST · Enter one of your students for an exam GET · List your students’ applications for one exam GET · List one of your students’ applications in this organization GET · Fetch one of your students’ applications PUT · Move one of your students’ applications to another exam DELETE · Withdraw one of your students from an exam GET · Download a certificate file GET · List one of your students’ released certificates GET · Download a result report file GET · List one of your students’ released result reports GET · List the group challenges an organization runs GET · Fetch one group challenge GET · List the groups your students are in for a group challenge GET · Fetch one group, with its steps and files GET · List what has happened in one group POST · Send a group’s finished work for one of your students POST · Submit one step of a group for one of your students GET · List your students’ eligibility and groups for a group challenge GET · Fetch one of your students’ eligibility and group for a group challenge
API account
GET Fetch the API account your token belongs to
/v1/api-account/validate-me Reference
Choosing another endpoint clears the form, token included.
Loading the sandbox console…
Endpoints Health GET Check that the API is up /v1/health API account POST Revoke the token you send, before it expires /v1/api-account/revoke-token GET Fetch the API account your token belongs to /v1/api-account/validate-me Reference data GET List the countries a student can be registered in /v1/country GET Fetch one country by its id /v1/country/{id} GET List the grades a student can be registered with /v1/grade GET Fetch one grade by its id /v1/grade/{id} GET List the organizations and their ids /v1/organization GET Fetch one organization by its id /v1/organization/{id} Students GET List your students /v1/student POST Register a student /v1/student POST Check a registration without registering the student /v1/student/check POST Register many students at once /v1/student/import GET Follow a batch of students you sent /v1/student/import/{importId} GET Fetch one of your students /v1/student/{studentId} PUT Update one of your students /v1/student/{studentId} PUT Set the sign-in password of one of your students /v1/student/{studentId} /password GET List your students who can use this organization /v1/{organizationId} /student GET Fetch one of your students, if they can use this organization /v1/{organizationId} /student/{studentId} PUT Update one of your students and give them access to this organization /v1/{organizationId} /student/{studentId} PUT Link one of your students to a supervisor on this organization /v1/{organizationId} /student/{studentId} /supervisor Sign-in links POST Create a single-use sign-in link for one of your students /v1/{organizationId} /auth/signin Exams GET List the exams open for applications /v1/{organizationId} /exam GET List an organization’s exam categories /v1/{organizationId} /exam-category GET Fetch one exam category /v1/{organizationId} /exam-category/{categoryId} GET List the exams one of your students can apply to /v1/{organizationId} /exam/available/{studentId} GET Fetch one exam that is open for applications /v1/{organizationId} /exam/{examId} Applications GET List your students’ applications in this organization /v1/{organizationId} /application POST Enter one of your students for an exam /v1/{organizationId} /application GET List your students’ applications for one exam /v1/{organizationId} /application/exam-applications/{examId} GET List one of your students’ applications in this organization /v1/{organizationId} /application/student-applications/{studentId} GET Fetch one of your students’ applications /v1/{organizationId} /application/{applicationId} PUT Move one of your students’ applications to another exam /v1/{organizationId} /application/{applicationId} DELETE Withdraw one of your students from an exam /v1/{organizationId} /application/{applicationId} Documents GET Download a certificate file /v1/{organizationId} /certificate/download/{certificateId} GET List one of your students’ released certificates /v1/{organizationId} /certificate/{userId} GET Download a result report file /v1/{organizationId} /report/download/{reportId} GET List one of your students’ released result reports /v1/{organizationId} /report/{userId} Group challenges GET List the group challenges an organization runs /v1/{organizationId} /group-challenge GET Fetch one group challenge /v1/{organizationId} /group-challenge/{challengeId} GET List the groups your students are in for a group challenge /v1/{organizationId} /group-challenge/{challengeId} /group GET Fetch one group, with its steps and files /v1/{organizationId} /group-challenge/{challengeId} /group/{groupId} GET List what has happened in one group /v1/{organizationId} /group-challenge/{challengeId} /group/{groupId} /activity POST Send a group’s finished work for one of your students /v1/{organizationId} /group-challenge/{challengeId} /group/{groupId} /final-submit POST Submit one step of a group for one of your students /v1/{organizationId} /group-challenge/{challengeId} /group/{groupId} /step/{stepId} /submit GET List your students’ eligibility and groups for a group challenge /v1/{organizationId} /group-challenge/{challengeId} /student GET Fetch one of your students’ eligibility and group for a group challenge /v1/{organizationId} /group-challenge/{challengeId} /student/{studentId} 