Embeddable UI

The IELTS and TOEFL Single CTA Embeddable UI provides a streamlined, interactive solution for integrating language assessments directly within educational platforms. This embeddable UI allows students to practice specific IELTS and TOEFL writing tasks and receive instant, AI-driven feedback. It is designed for seamless integration at various stages of the user journey, from lead generation to in-class assessments, providing a versatile tool for edtech platforms, training centers, and classrooms.

​

Core Product Capabilities

• Embeddable UIs

  1. Single-Click CTA: Provides instant access to TOEFL and IELTS writing tasks, allowing students to practice with authentic exam formats, including essay-based and graph-based prompts.
  2. Instant Evaluations: Offers immediate feedback on submitted answers, powered by specialized Evaluations APIs for IELTS and TOEFL.
  3. Customization Options: Allows UI customization to align with client branding, ensuring a cohesive experience for students.

• Evaluations and Feedback

  1. Overall Score: Provides students with a standardized score upon submission.
  2. Holistic Evaluation Rubrics: Offers detailed scores across Task Response, Coherence & Cohesion, Grammatical Range, and Lexical Resource.
  3. Objective Feedback: Interactive spelling and grammar suggestions help students identify and learn from mistakes.

​

Key Features of IELTS and TOEFL Single CTA Embeddable UI

• Single-Click Access to Writing Tasks: Students can access IELTS and TOEFL writing tasks with a single click, instantly engaging with essay and graph-based prompts for a realistic test experience.
• Instant Evaluations: Provides AI-powered, real-time evaluations upon submission, including:
  1. Overall Score: Reflects the student’s performance.
  2. Evaluation Rubrics: Detailed breakdown across key assessment categories.
  3. Objective Feedback: Highlights spelling and grammar suggestions within the response.
• Generate Answer Option: Offers sample answers for users exploring the evaluation features, useful in lead-generation scenarios. This option can be disabled in classroom or engagement settings.
• Brand Customization: Customizable options for color, fonts, and layout allow alignment with client branding.
• Versatile for Different Funnel Stages: Adaptable across lead generation, engagement, nurturing, and classroom scenarios to meet various educational needs.
• Configurable for Specific Usage: Flexible setup for use as either a stand-alone assessment tool or an embedded feature within a larger educational platform.

​

Conclusion

We hope this documentation has provided a helpful overview of the IELTS and TOEFL Single CTA Embeddable UI. This tool can be integrated within 24 hours, delivering instant, standardized evaluations for TOEFL and IELTS tasks with single-click ease and customizable UI options to align with your brand. By using our embeddable solution, you can focus your resources on growth rather than building in-house capabilities, while gaining a versatile tool that enhances engagement and streamlines assessments across lead generation, classroom use, and more.

We also offer additional API documentation:

TOEFL Evaluations API

IELTS Evaluations API

For further information, please reach out to us at info@crazygoldfish.com. We look forward to supporting your assessment needs!

​

How the Product Works

• Authorization and Link Generation: The client generates an embeddable UI link via the Embeddable UI API. This link can be embedded at various points along the user journey for seamless access to IELTS and TOEFL assessments.
• Embedding and Customization: The embeddable link can be customized to match the client’s branding, ensuring a cohesive experience. The UI can be embedded on pages for lead capture, engagement, or classroom practice.
• Answer Submission and Evaluation: Upon submitting an answer, students receive real-time evaluations powered by either the IELTS Evaluations API or the TOEFL Evaluations API, depending on the test type.

​

APIs Used

The Embeddable UI uses dedicated IELTS Evaluations API and TOEFL Evaluations API endpoints for tailored evaluations, in addition to the Embeddable UI API for generating links and embedding the user interface.

​

Embeddable UI API

The Embeddable UI API handles the creation and customization of the embeddable UI links, allowing clients to embed TOEFL and IELTS assessments on their platforms seamlessly.

• Endpoint: ‘/exams/embeddable-ui-link’

• Purpose: Generates a unique link for embedding either the TOEFL or IELTS writing assessment.

• Key Parameters:

  Parameter	Type	Description
  embeddable_ui_id	String	Identifier for the specific embeddable UI instance.
  institute_id	String	Optional identifiers for tracking.
  teacher_id	String	Optional identifiers for tracking.
  parent_id	String	The parent’s ID.
  student_id	String	Optional identifiers for tracking.
  student_name	String	Name of the student using the link.

  For your reference, the following table lists the embeddable IDs for IELTS and TOEFL:

  embeddable_ui_id	Description
  IE-AC-W-01	IELTS AC Writing: Task 1 - Writing a letter to respond to a situation
  IE-AC-W-02	IELTS AC Writing: Task 2 - A point of view, argument, or problem which you need to discuss
  IE-GT-W-01	IELTS Essentials Writing: Email Detailed - Describe some visual information in your own words
  IE-GT-W-02	IELTS Essentials Writing: Academic Discussion - A point of view, argument, or problem which you need to discuss
  TF-ES-W-01	TOEFL Essentials Writing: Build a Sentence
  TF-ES-W-02	TOEFL Essentials Writing: Email Brief
  TF-ES-W-03	TOEFL Essentials Writing: Email Detailed
  TF-ES-W-04	TOEFL Essentials Writing: Describe a Photo
  TF-ES-W-05	TOEFL Essentials Writing: Academic Discussion
  TF-IB-W-01	TOEFL IBT Writing: Integrated Writing
  TF-IB-W-02	TOEFL IBT Writing: Academic Discussion

• Usage: Once generated, the link can be integrated on any page to provide instant access to TOEFL and IELTS assessments.

​

Integration Guide

• Access the API: Obtain the necessary API token to authorize requests and create embeddable UI links for either TOEFL or IELTS assessments.
• Generate and Embed the Link: Use the Embeddable UI API to create a link, and embed it within your platform at the preferred user journey stage.
• Configure Branding and Customization: Customize the UI with preferred colors and layout to match your platform’s branding.
• Monitor Engagement: Track user performance through instant feedback and evaluate engagement metrics.

​

Authentication

To access the Embeddable UI API, you will need an API token. API tokens are generated from the authentication API. Be sure to securely store your API token, as it is required for generating the test link.

​

Endpoints

POST /exams/embeddable-ui-link

{
  "embeddable_ui_id": "IE-GT-W-02",
  "institute_id": "inst_456",
  "teacher_id": "",
  "parent_id": "",
  "student_id": "123",
  "student_name": "crazygoldfish"
}

{
  "embeddable_ui_requested": "https://mock-test.crazygoldfish.com/exam/<unique_id>/?client_id=1",
  "client_id": 1,
  "institute_id": "inst_456",
  "teacher_id": "",
  "parent_id": "",
  "student_id": "123",
  "student_name": "crazygoldfish"
}

​

Embedding the UI

Example Embed Code:

<iframe src="https://mock-test.crazygoldfish.com/exam/<unique_id>/?client_id=1" width="600" height="400" frameborder="0" allowfullscreen></iframe>

You can adjust the width and height parameters to ensure the embedded UI fits perfectly within your platform.

​

Error Handling:

The Embeddable UI API provides meaningful error messages to guide you in fixing issues quickly.

Common errors include:

​

Customization

You can customize the embeddable UI to align with your platform’s branding.

​

Available Customization Options:

• Theme Colors: Adjust colors to match your platform.
• Fonts: Select fonts from a predefined list or provide your own custom fonts.

Embeddable UI IDs are unique identifiers assigned to specific user interfaces tailored for various tasks within the TOEFL and IELTS assessments. These identifiers correspond to predefined configurations, ensuring seamless integration of assessment components into your platform. While a comprehensive catalog of these IDs is available, we also offer custom configurations upon request to meet specific requirements. For your reference, the following table lists the IELTS and TOEFL embeddable UI IDs alongside their corresponding tasks:

​

IELTS Embeddable UI IDs :

​

TOEFL Embeddable UI IDs: