- 01 Oct 2024
- 1 Minute to read
- Print
- PDF
Jobs API overview
- Updated on 01 Oct 2024
- 1 Minute to read
- Print
- PDF
API Contacts
01488 684321
API Terms of Use
Click here to view our API terms of use.
Terms
Partner = Third party middleware application ( Broadbean, Vacancy Poster, Idibu, LogicMelon, Job Mate, SFSF Recruiting Posting, Vacancy Filler, 3D MarComms, Zest, CV Minder, Wave, Eploy, Recruit Genie, Recruitive, Talent Track / E Sales Hub, Harri, Seem Hired currently supported Partners) for posting jobs on behalf of a Member of carehome.co.uk
Member = A Care Home/Nursery/ Home Care Agency or a Recruitment Agency with an account on carehome.co.uk
Overview
The API’s we provide give access to all methods available through our web based control panel via a JSON REST interface. This includes the ability to post, edit (not all fields editable), renew and close jobs. All option-based fields also have their own API’s to give an up to date array of values to use with them.
Authentication
To make a request to our API you must pass the API_key of the client in question, these keys may be passed either in the URL (for GET requests) or in the JSON body of the request in other methods (PUT/POST). When using the API as a Partner you must also pass your assigned partner key on ALL requests.
API Keys are automatically assigned to all Members on creation but Partner Keys are generated on request.
eg for a Member
GET https://api.carehome.co.uk/index.cfm/jobs/175893?api_key=000
eg for a Partner
GET https://api.carehome.co.uk/index.cfm/jobs/175893?api_key=000&partner_key=000
Going Live for Partners Integrating with carehome.co.uk / homecare.co.uk / daynurseries.co.uk
If you are a Partner setting up an integration on behalf of a Member you will need to request the Member API key from the Member directly or email us using the details at the top of the document requesting the Member details with the Member contact cc'd in the email, and when the Member has replied confirming the access, we will supply their API Key.