There are two ways of accessing TutorCruncher's API, either straight to the API, or using TutorCruncher Socket Server.
At the moment there is nothing that can be accessed through the API that can't be accessed with TutorCruncher Socket Server, so we recommend using that.
TutorCruncher Socket Integration
With TutorCruncher Socket, you can List your tutors online, allow clients to enquire and directly request a tutor, and also allow clients to book lessons. Socket uses TutorCruncher’s API. If you wish to implement Socket on your website, then follow our setup guide.
We offer web development services for companies looking for a new website that can be fully integrated with TutorCruncher. Look at website for an example of the kind of service that we can offer.
How do I enable Socket within TutorCruncher?
Under System > Settings > People and Activity > People, enable the 'Public Tutor profiles' option.
Go to System > Settings > TutorCruncher API > API Integrations, and click 'Add Socket Integration'.
Once you've clicked that, you'll have the following:
Your public API key is included in the Webhook URL.
Your private API key is the one under API key and should never be shared within anyone.
Using Socket on my website
There are three main options for using Socket on your website.
Use Socket to embed an enquiry form on your website so that clients can create an enquiry. See an example.
How do I find my public API key?
Once you have Socket enabled, your API key can be found under System > Settings > TutorCruncher API > Integrations and look for the integration called Socket Integration.
Your public API key is the one included in the Webhook URL between
/contractors/set. In this case,
123456789abc, and will be used to integrate Socket into your website.
Do not share the API key (abc123...) with anyone.
Do you have a test key I can use?
You can use '9c79f14df986a1ec693c' as a test key to work with any socket integration.
Please note that this will not submit anything to your TutorCruncher account.
The first step is to import socket into the page.
Anywhere on the page between either the
<body></body> tags, insert the following line:
We recommend putting it just before the last