Use socket to list my tutors on my website

Setup Socket Integration.

Wherever you wish to include the tutors, put in the following line:

<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. How do I find that?

See here for an example.

How do I let clients request a tutor?

As long as you have a tutor listed on your website, your clients can request a tutor.

See here for an example.

If a client requests a tutor, I'd like a job to be created with the tutor and client attached

No problem!

Under System > Settings > People and Activity > Activity, enable the 'Create job for enquiries' option. 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 can I choose which tutors should be displayed?

Go to the tutors that you want to approve and apply the label 'Public Profile'.

You can then view the fields that will be displayed under System > Settings > Integrations > Approve Tutor Profiles.

If no tutors are listed, you can click the 'Refresh Public Profiles' button. If you still have no tutors displayed, you will need to check that you have applied the 'Public Profile' label correctly.

If you think a tutor's profile is ready to be listed, click the 'Approve' button next to each tutor.

How to approve Public Tutor Profiles?

Our website integration TutorCruncher Socket allows you to automatically display tutor profiles on your website. Get up more information on how to set up Socket below. Once Socket is integrated with your website, you will need to approve public tutor profiles to display them on your website.

Step by Step Process

To determine which tutor profiles will be public, go to the tutor whose profile should be public and apply the label 'Public Profile'.
Under System > Settings > Integrations > Approve Public Tutor Profiles you can then view the profile that will be displayed.
If no tutors are listed, you can click the 'Refresh Public Profiles' button.
If you still have no tutors displayed, you will need to check that you have applied the 'Public Profile' label correctly.
If an admin 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.

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 check the 'Client Accessible' option so that they are displayed.

Please note: It can take up to 24 hours for changes to customisable fields to display on your website via Socket.

More Information

Click here for more inforamtion on how to integrate Socket with your website.

My tutor's profiles on my website seem out of date, how do I update them?

If an admin or a tutor makes a change to a public profile, then you'll need to approve the change under System > Settings > TutorCruncher API > Approve Tutor Profiles.

How can I remove a public tutor profile?

If you don't want a public tutor profile displayed on your website anymore, first remove the label 'Public Profile' on the tutor in TutorCruncher by clicking on it in the dropdown menu. Then go to System > Settings > TutorCruncher API > Approve Public Tutor profiles and click the button 'Refresh Public Profiles'. To remove the tutor's profile you then have to 'Approve and Release' the deleted profile again. Refresh your website to see if the profile was removed.

How can I customise the fields that will be displayed?

Don't forget to update your list of tutors afterwards!

Please note: Editing the fields shown inside TutorCruncher socket can take up to 24 hours to update.

Getting a list of tutors

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:

https://socket.tutorcruncher.com/9c79f14df986a1ec693c/contractors

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.

What fields do I get on the list of tutors?

Fields	Description	Example
`distance`	Used to filter your users by distance to an address/postcode
`id`	The tutor's ID within TutorCruncher	214699
`link`	The link that will be generated for their profile	214699-martha-s
`name`	The tutor's name	Martha S
`photo`	A link to the tutor's profile picture	https://socket.tutorcruncher.com/media/9c79f14df986a1ec693c/214699.thumb.jpg
`primary_description`	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.
`tag_line`	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
`town`	The town the tutor has listed in their address	Putney
`url`	A link to more details about that contractor (see below)	https://socket.tutorcruncher.com/9c79f14df986a1ec693c/contractors/214699
`country`	The country the tutor has entered in their address	United Kingdom

How do I get more details about a tutor (like their teaching skills, other custom Fields etc)?

Going to the url link above will give you more details about the tutor.

For instance https://socket.tutorcruncher.com/9c79f14df986a1ec693c/contractors/214699

What fields do I get on a tutor's details link?

Fields	Description	Example
`country`	The country the tutor has entered in their address	United Kingdom
`extra_attributes`	All of the details about custom Fields associated with the tutor that are publicly viewable.	`[` `{` `"machine_name": "tag-line"` `"name": "Tag Line"` `"sort_index": 0.0` `"type": "text_short"` `"value": "Fantastic Maths Tutor available throughout London"` `}` `]`
`id`	The tutor's ID within TutorCruncher	214699
`name`	The tutor's name	Martha S
`photo`	A link to the tutor's profile picture	https://socket.tutorcruncher.com/media/9c79f14df986a1ec693c/214699.jpg
`primary_description`	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.
`tag_line`	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
`town`	The town the tutor has listed in their address	Putney
`skills`	The skills a tutor has listed on their profiles.	`[` `{` `"category": "Maths"` `"qual_levels": [` `"11+",` `"13+"` `],` `"subject": "Mathematics"` `}` ]

As you can see above, Custom Fields and Skills are listed with other details relevant to them.

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.

Socket parameters

Name	Default	Description
`api_root`	TutorCruncher Socket Backend	The URL of the backend you wish to use. TutorCruncher Socket Backend
`element`	`#socket`	The id of the element created
`router_mode`	`hash`	The routing mode when clicking on a tutor's profile.
`mode`	`grid`	Which mode you want to use (explained below)
`url_root`	`/`	The root URL of the page you are using Socket from eg. '/our-tutors/'
`subject_filter`	`true`	Whether or not the subject filter is displayed

We use some strings within Socket that you may want to change by passing them as parameters also.

Name	Default string
`skills_label`	'Skills'
`contractor_enquiry_message`	'Please enter your details below to enquire about tutoring with {contractor_name}.'
`enquiry_message`	'Please enter your details below and we will get in touch with you directly.'
`contractor_enquiry_button`	'Contact {contractor_name}'
`contractor_details_button`	'Show Profile'
`submit_enquiry`	'Submit Enquiry'
`enquiry_submitted_thanks`	'Enquiry submitted, thank you.\n\nYou can now close this window.'
`enquiry_button_text`	'Get in touch'

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 you customise within TutorCruncher, as per here

Generates a button inside the page which, when clicked, will load a modal of the enquiry form. More about modals.

How do I enable showing public tutor profiles?

You can have your tutors profiles shown through the API by going to Settings > People & Activity > People & enable the box for 'Public Tutor Profiles'. This generates public profiles for tutors which will then be accessible via the API.