Skip to content

🧩 API Methods

Eye By Proctorme exposes a small, event-driven JavaScript API that allows you to initialize proctoring, listen to events, and manually end a session.

All interaction happens through the widget instance returned by LoadProctormeWidget().

Getting the Widget Instance

Before calling any API method, you must load the widget:

const widget = await LoadProctormeWidget();

Async loading

LoadProctormeWidget() returns a Promise. Always use await or .then() before accessing widget methods.

Available Methods

Method Description
widget.init(config) Initializes the proctoring session
widget.on(event, callback) Listens for widget events
widget.endProctoring() Ends the proctoring session manually

widget.init(config)

Initializes the proctoring session using the provided configuration object.

Signature

widget.init(config: Config): void

Example

widget.init({
  apiKey: "YOUR_API_KEY",
  assessmentId: "assessment123",
  assessmentTitle: "Frontend Development Assessment",
  candidateId: "candidate456",
  candidateEmail: "test@example.com",
  candidateFirstName: "John",
  candidateLastName: "Doe",
  institutionName: "Tech Academy International",
  examDuration: 1800,
  features: {
    aiProctoring: true,
    facialRecognition: true,
  },
});

Initialization requirements

  • All required config fields must be provided
  • The API key must be valid
  • The current domain must be registered

If initialization fails, the widget will not start proctoring.

widget.on(event, callback)

Registers an event listener for a specific proctoring event.

Signature

widget.on(event: string, callback: (payload?: any) => void): void

Example

widget.on("FACE_ABSENCE", (data) => {
  console.log("Face not detected", data);
});

Common Events

widget.on("STARTED", () => {});
widget.on("END_PROCTORING", () => {});
widget.on("SOUND_DETECTED", (data) => {});
widget.on("MULTIPLE_FACE", (data) => {});
widget.on("TAB_NOT_FOCUS", (data) => {});

Event-driven design

All monitoring signals (face, sound, tab focus) are delivered through events. There is no polling API.

👉 See the full list in Events documentation

widget.endProctoring()

Manually ends the proctoring session.

Signature

widget.endProctoring(): void

Example

widget.endProctoring();

Behavior

  • Stops all monitoring immediately
  • Triggers the END_PROCTORING event
  • Finalizes the candidate session

Irreversible action

Once ended, a proctoring session cannot be resumed.

Typical Usage Flow

flowchart LR
    A[Load Widget] --> B[Register Events]
    B --> C[widget.init]
    C --> D[Monitoring Active]
    D --> E[widget.endProctoring]

Common Mistakes

Avoid these

  • Calling widget.init() before loading the widget
  • Registering event listeners after initialization
  • Ending the session unintentionally

← Back to Configuration | Next: Events →

If you need help handling events or building logic on top of these methods, refer to the Events documentation.