Integration 2018-06-05T01:35:23+00:00

Integrate with FeedbackPanda

FeedbackPanda offers a common link format that enables Online ESL Teaching Platforms to offer a button or link in their Feedback, Report and Evaluation views. When visited, this link will load the FeedbackPanda application, validate the data that was transmitted and pull up the Teacher’s data, should he or she be logged in.

Technical Implementation

The link has to satisfy this structure:

https://app.feedbackpanda.com/#/external?data=<encoded data>

Structure

The data needs to be a base64-encoded string of a serialized JSON object, that has to satisfy this (exemplified) structure:

{
  "school": "vipkid", // has to be a supported school as a string value, required
  "student_id": "3334222", // has to be a non-empty string, required
  "course_id": "5552333", // has to be a non-empty string, required
  "classroom_id": "313411231" // used to prevent duplication, has to be a non-empty string, optional
  "student_suggested_name": "Bao bao (Jimmy)" // if the teacher has not yet saved this student on FeedbackPanda, this should be the name of the student. if provided with a second name in parentheses, that will be the student's nickname. has to be a non-empty string, optional
  "course_suggested_name": "Lesson 1, Unit 2", // if the teacher has not yet saved this course on FeedbackPanda, this should be the course name. has to be a non-empty string, optional
  "meta_data": {}, // any JSON object. Optional. 
  "custom_data": {} // any JSON object. use to send any other relevant information here. Class times, special settings, teaching modes. Optional.
}

Encoding
As an example, the following data


{
  "school": "vipkid",
  "student_id": "3334222",
  "course_id": "5552333",
  "classroom_id": "313411231",
  "student_suggested_name": "Bao bao (Jimmy)",
  "course_suggested_name": "Lesson 1, Unit 2"
}

will result in the following string when first stringified and then base64-encoded:

eyJzY2hvb2wiOiJ2aXBraWQiLCJzdHVkZW50X2lkIjoiMzMzNDIyMiIsImNvdXJzZV9pZCI6IjU1NTIzMzMiLCJjbGFzc3Jvb21faWQiOiIzMTM0MTEyMzEiLCJzdHVkZW50X3N1Z2dlc3RlZF9uYW1lIjoiQmFvIGJhbyAoSmltbXkpIiwiY291cnNlX3N1Z2dlc3RlZF9uYW1lIjoiTGVzc29uIDEsIFVuaXQgMiJ9

The resulting link would then be https://app.feedbackpanda.com/#/external?data=eyJzY2hvb2wiOiJ2aXBra…

When clicked, this link will open FeedbackPanda for the teacher, pull up their VIPKID school and load the student and course from their own database. If they aren’t present, the suggested names will be placed in the create views.

Supported schools

We currently support these values for the “school” property:

  • vipkid
  • alo7
  • magicears
  • landi_english

If your school is not in this list, please reach out to us a engineering@feedbackpanda.com to build a low-level integration that will enable the link for your school.

Questions

If you have any question about how to implement the link, please reach out to us a engineering@feedbackpanda.com