You can use the Posting API to send candidate applications direct to Recruit So Simple from your own website or system. Applications will be viewable under [Candidates > Web Import] where they can be reviewed.
Please note that when an application is received via the API, an email notification will not be generated. If an email notification is required this will need to be sent from your website/system.
The API accepts the following JSON encoded fields:
| Data field | Requirements | Example |
|---|---|---|
| firstName (required) | Max 64 characters | James |
| lastName (required) | Max 64 characters | Clayson |
| phone (required) | Max 32 characters | 01234567890 |
| email (required) | Max 64 characters | james@email.com |
| cvData | Max 10MB (Base64 encoded) | YWJjMTIzIT8kKiYoKSctPUB etc |
| cvFilename | Max 128 characters | cv.pdf |
| job | Valid job ID | 123 |
| question | Max 2000 characters | Do you hold a full drivers licence? |
| answer | Max 2000 characters | Yes |
Where to find your API key
Your API key can be found in [Settings > System Settings > Web > Advanced].
There is a rate limit of 200 requests per hour.
If an invalid key is provided there will be no response from the API.
Responses
Once the data is posted then an array is returned with either a 200 Success response, or if there are any errors then these will be returned.
PHP Example Code
The following example code can be used to post to the API . The unique key should be kept hidden and not viewable in the source code of the page. Anyone with your key will be able to post to your account.
The API will return an error if invalid data is provided (for example, an invalid email address or missing first name etc).
$file = file_get_contents("cv.pdf");
$base64 = base64_encode($file);
$data = array( 'firstName' => 'James',
'lastName' => 'Clayson',
'phone' => '01234567890',
'email' => 'james@email.com',
'cvData' => $base64,
'cvFilename' => 'cv.pdf',
'job' => '123',
'question' => 'Do you hold a full drivers licence?',
'answer' => 'Yes'
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.recruitsosimple.com/post/v1/[YOUR-KEY-HERE]");
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
print_r($response);