API docs by Redocly

Exam Session Purchase API (1.0.0)

Download OpenAPI specification:Download

This API provides access to SOPbot's exam session purchase functionality. You will need a billing code to use this API. You can get one at https://sopbot.work/SetupBilling.

Purchase exam session

Purchase an exam session for a document. This will automatically charge the payment method associated with the billing code and send an email inviting each examinee to their individual session.

Request Body schema: application/json
required
documentURL
required
string <uri>

URL to the document for the exam session. Must be in one of the following formats: PDF.

required
Array of objects

List of recipient objects for the exam session.

callbackEmail
string <email>

Email address where transcript will be sent upon completion.

callbackPostURL
string <uri>

URL for POST callback upon completion. Will include JSON object with session information and transcript.

billingCode
required
string

Billing code for the transaction.

Responses

Request samples

Content type
application/json
{
  • "documentURL": "http://example.com",
  • "recipients": [
    ],
  • "callbackEmail": "user@example.com",
  • "callbackPostURL": "http://example.com",
  • "billingCode": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "sessionInfo": [
    ]
}