Before starting, you will need to enable Public Tutor Profile functionality by navigating to System > Settings > People and Activity > Clients Booking Lessons & Tutors and enable the 'Public Tutor Profiles'. This generates public profiles for Tutors which will then be accessible via the API.
Wherever you wish to include the Tutors, input the following code:
<div id="socket"></div>
Then, below where you have imported Socket, put in the following:
<script>
socket('YOUR_API_KEY')
</script>You need to replace YOUR_API_KEY with your public API key.
See here for an example.
Socket Fields for a Tutor's details:
Fields | Description | Example |
| Used to filter your users by distance to an address/postcode | N/A |
| The tutor's ID within TutorCruncher | 214699 |
| The link that will be generated for their profile | 214699-martha-s |
| The tutor's name | Martha S |
| A link to the tutor's profile picture | |
| The Custom Field with the name 'Primary Description', or the first custom Field that is of type Text Long, arranged in order of priority. | I have been a Maths teacher (13+) since I graduated from university and tutor students outside of work. I also have experience in working with students with learning disorders. |
| The Custom Field with the name 'Tag Line', or the first custom Field that is of type Short Text, arranged in order of priority. | Fantastic Maths Tutor available throughout London |
| The town the tutor has listed in their address | Putney |
| A link to more details about that contractor (see below) | |
| The country the tutor has entered in their address | United Kingdom |
| Include a list of the label machine names | N/A |
| Exclude a list of the label machine names | N/A |
Socket Parameters:
Name | Default | Description |
| TutorCruncher Socket Backend | The URL of the backend you wish to use. TutorCruncher Socket Backend |
|
| The id of the element created |
|
| The routing mode when clicking on a Tutor's profile |
|
| Which mode you want to use (explained below) |
|
| The root URL of the page you are using Socket from eg. '/our-tutors/' |
|
| Whether or not the subject filter is displayed |
|
| Whether or not the hours reviewed is displayed |
|
| Whether or not the labels are displayed |
|
| Whether or not the location search is displayed |
|
| Whether or not the stars are displayed |
We use some strings within Socket that you may want to change by also passing them as parameters:
| 'Skills' |
| 'Please enter your details below to enquire about tutoring with {contractor_name}.' |
| 'Please enter your details below and we will get in touch with you directly.' |
| 'Contact {contractor_name}' |
| 'Show Profile' |
| 'Submit Enquiry' |
| 'Enquiry submitted, thank you.\n\nYou can now close this window.' |
| 'Get in touch' |
Socket display modes:
Grid: Generates a
<div>of your Tutors in a grid format, as per the example here.Enquiry: Generates an enquiry form inside the page using fields that you can customise within TutorCruncher, as per the example here.
Enquiry Modal: Generates a button inside the page which, when clicked, will load a modal of the enquiry form. Read more about modals here.
How do I allow my Clients request a Tutor directly?
As long as you have a Tutor listed on your website, your Clients can request a Tutor.
See here for an example.
How do I automatically create a Job whenever a Client requests a Tutor?
Navigate to System > Settings > People and Activity > Activity and enable the 'Create Job for enquiries' checkbox. Now, whenever a Client enquires, a new Job will be created with the Tutor listed as an applicant for it. You can then decide whether or not to assign that Tutor or choose a different one.
How do I choose which Tutors should be displayed?
Navigate to the Tutor profiles that you want to approve and apply the 'Public Profile' Label.
You can then view the fields that will be displayed within System > Settings > Integrations > Approve Tutor Profiles.
If no Tutors are listed, you can click the Refresh Public Profiles button to refresh the list. If you still have no Tutors displayed, you will need to check that you have applied the 'Public Profile' Label correctly.
If a Tutor's profile is ready to be listed, click the Approve button next to their item on the list.
How do I approve public Tutor profiles?
Our website integration TutorCruncher Socket allows you to automatically display Tutor profiles on your website. Get more information on how to set up Socket in the video below. Once Socket is integrated with your website, you will need to approve public tutor profiles to display them on your website.
The steps outlined in this video:
Apply the 'Public Profile' Label to the Tutor profiles that you want to list.
Navigate to System > Settings > Integrations > Approve Public Tutor Profiles to review and approve the Tutor profiles
If no Tutors are listed, you can click the Refresh Public Profiles button to refresh the list.
If you still have no Tutors displayed, check that you have applied the 'Public Profile' Label to their profiles.
If an Administrator or a Tutor makes a change to a public profile, then you'll need to approve the change in the same way as releasing them initially.
If you think a Tutor's profile is ready to be listed, click the Approve and release button next to each Tutor's profile on the list.
My Tutor's profiles on my website are out of date, how do I update them?
If an Administrator or Tutor makes a change to a public profile, then you'll need to approve those changes via System > Settings > Approve Public Tutor Profiles.
How do I remove a public Tutor profile?
To remove a public Tutor profile, follow these steps:
Navigate to their Tutor profile within TutorCruncher and remove the 'Public Profile' Label.
Navigate to System > Settings > Integrations > Approve Public Tutor Profiles and click Refresh Public Profiles.
You will then need to select Approve and Release on the profile you removed that Label from and refresh your website for the listing to be removed.
Can I customise the fields that will be displayed on the Tutor listings?
By default, the Tutor's name and town will be displayed in Socket, as well as any teaching skills they have chosen. To add more fields, simply add or edit Custom Fields and make sure to enable the 'Client can access' checkbox so that they are displayed.
Note: It can take up to 24 hours for changes to customisable fields to display on your website via Socket.
How do I get a list of Tutors using the API?
If you make a request in the format below, you can get the list of the Tutors you have made publically accessible.
https://socket.tutorcruncher.com/contractors/
If we take our demo branch as an example:
Example of listing Tutors on a website:
<body>
<h1>This is a webpage for my tuition agency</h1>
<p>Listed below are my tutors</p>
<div id="socket"></div>
<p>We just love using TutorCruncher for our business.</p>
<script src="https://cdn.tutorcruncher.com/socket/latest/socket.js"></script>
<script>
socket('YOUR_API_KEY')
</script>
</body>
See here for an example of it in action.
Example of listing Tutors and embedding an enquiry form:
<body>
<h1>This is a webpage for my tuition agency</h1>
<p>Listed here are my tutors</p> <div id="socket"></div>
<p>Get in touch by filling in the contact form below</p>
<div id="socket-enquiry">
</div>
<p>We just love using TutorCruncher for our business.</p>
<script src="https://cdn.tutorcruncher.com/socket/latest/socket.js"></script>
<script>
socket('YOUR_API_KEY', {
mode: 'enquiry',
element: '#socket-enquiry'
})
</script>
<script>
socket('YOUR_API_KEY')
</script>
</body>
See here for an example of it in action.
How do I get more details about a Tutor?
To get more details about a Tutor, (such as their teaching skills or any other Custom Fields etc.), navigate to this URL link.