POST - Embeddable UI Link

The Embeddable UI API allows platforms to generate a unique embeddable link for a pre-configured user interface. This UI enables users to upload handwritten answer sheets, view model answers, and receive detailed evaluations. The API simplifies the integration process, making it easy for platforms to offer this functionality as part of their workflows.

Scenario: Integrating the Embeddable UI into an Educational Platform:

Platform Integration:
- An educational platform wants to provide users with the ability to upload handwritten answer sheets, view model answers, and receive evaluations. Instead of building a custom interface, they use the Embeddable UI API to generate a unique embeddable link.
- The link is pre-configured to provide:
  - Upload options for handwritten answer sheets in PDF or image format.
  - A view to compare their answers with model answers.
  - Detailed evaluations of their answers based on the model answers and marking scheme.
Outcome:
- The platform seamlessly embeds the UI into their system, allowing users to interact with the grading and evaluation features without navigating away from the main educational platform.

POST

evaluation-platform

embeddable-ui-link

Get Embeddable UI Link

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}
'

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/"

payload = {
    "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
    "studentId": "2017009807",
    "instituteId": "98765",
    "teacherId": "54321",
    "studentName": "John Doe",
    "parentId": "11223"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    examId: '4340132f-50fa-4877-9ffa-e9b7ee59d51f',
    studentId: '2017009807',
    instituteId: '98765',
    teacherId: '54321',
    studentName: 'John Doe',
    parentId: '11223'
  })
};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'examId' => '4340132f-50fa-4877-9ffa-e9b7ee59d51f',
    'studentId' => '2017009807',
    'instituteId' => '98765',
    'teacherId' => '54321',
    'studentName' => 'John Doe',
    'parentId' => '11223'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/"

	payload := strings.NewReader("{\n  \"examId\": \"4340132f-50fa-4877-9ffa-e9b7ee59d51f\",\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"examId\": \"4340132f-50fa-4877-9ffa-e9b7ee59d51f\",\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"examId\": \"4340132f-50fa-4877-9ffa-e9b7ee59d51f\",\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}"

response = http.request(request)
puts response.read_body

{
  "link": "https://k12.crazygoldfish.com/evaluate/4340132f-50fa-4877-9ffa-e9b7ee59d51f/answers/f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}

{
  "error": {
    "code": 400,
    "message": {
      "examId": [
        "Must be a valid UUID."
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

examId

string

required

Unique identifier of the exam

Example:

"4340132f-50fa-4877-9ffa-e9b7ee59d51f"

studentId

string

required

Unique identifier of the student

Example:

"2017009807"

instituteId

string | null

Unique identifier of the institution

Example:

"98765"

teacherId

string | null

Unique identifier of the teacher

Example:

"54321"

studentName

string | null

Name of the student

Example:

"John Doe"

parentId

string | null

Unique identifier of the parent

Example:

"11223"

Response

Answer sheet created successfully

link

string

Link to the embeddable UI

Example:

"https://k12.crazygoldfish.com/evaluate/4340132f-50fa-4877-9ffa-e9b7ee59d51f/answers/f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab"

studentId

string

Unique identifier of the student

Example:

"2017009807"

instituteId

string

Unique identifier of the institution

Example:

"98765"

teacherId

string

Unique identifier of the teacher

Example:

"54321"

studentName

string

Name of the student

Example:

"John Doe"

parentId

string

Unique identifier of the parent

Example:

"11223"

POST - Assignment This API allows authenticated users to **create a new assignment** by providing essential details like assignment name, institute info, and class metadata. **Key Notes:** - `assignmentName` (required): The title of the assignment. - `parentInstituteId`, `instituteId`, `courseId`: Help link the assignment to the correct organizational hierarchy. - `grade` and `section`: Specify the targeted academic group for the assignment. **Scenario: Creating an Assignment for Grade 8 - Section B** - A teacher wants to assign a new English essay task to Grade 8 students of Section B. - They send a POST request with all necessary metadata. - Upon success, the assignment is created and returns an ID, ready for document uploads and evaluation.

Get Embeddable UI Link

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}
'

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/"

payload = {
    "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
    "studentId": "2017009807",
    "instituteId": "98765",
    "teacherId": "54321",
    "studentName": "John Doe",
    "parentId": "11223"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    examId: '4340132f-50fa-4877-9ffa-e9b7ee59d51f',
    studentId: '2017009807',
    instituteId: '98765',
    teacherId: '54321',
    studentName: 'John Doe',
    parentId: '11223'
  })
};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'examId' => '4340132f-50fa-4877-9ffa-e9b7ee59d51f',
    'studentId' => '2017009807',
    'instituteId' => '98765',
    'teacherId' => '54321',
    'studentName' => 'John Doe',
    'parentId' => '11223'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/"

	payload := strings.NewReader("{\n  \"examId\": \"4340132f-50fa-4877-9ffa-e9b7ee59d51f\",\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"examId\": \"4340132f-50fa-4877-9ffa-e9b7ee59d51f\",\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"examId\": \"4340132f-50fa-4877-9ffa-e9b7ee59d51f\",\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}"

response = http.request(request)
puts response.read_body

{
  "link": "https://k12.crazygoldfish.com/evaluate/4340132f-50fa-4877-9ffa-e9b7ee59d51f/answers/f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}

{
  "error": {
    "code": 400,
    "message": {
      "examId": [
        "Must be a valid UUID."
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

POST - Embeddable UI Link

Authorizations

Body

Response