Importing Candidates

Candidates > Web Import

Candidates that have applied via your job board will appear here. Applications can be reviewed before adding them to the database. You can read more about the Web Import screen here.

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:

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);

1. Open a vacancy record and go to its Share screen.
2. Click Post to Broadbean.
3. Click Post Now.
4. Select from your subscribed job boards. Note that at this point you’re using Broadbean as if you were logged in directly via their website. Important note: Do not change the Job reference, this is used to match the applicant to the correct vacancy.
5. Vacancy details will be automatically pulled through. Follow the steps as if logged in to your Broadbean account.

Importing applications

1. Download applications from [Candidates > Web Import]. If you wish, you can flag candidates in Broadbean first, and then choose which to download, for example, ‘Suitable’ and ‘Maybe Suitable’.
2. Delete an application or click Review to add a candidate to your database.

See idibu.com for more information about their service.

Enable The Integration

Settings > System Settings > Job Boards

Check the box to enable the Idibu integration, enter your hash key and click the ‘Save’ button. The hash key for your Idibu account can be requested from Idibu’s technical support. Note that your hash key will change if you ever update the password for your Idibu admin user, in this case you will also need to update the hash key in our system.

Setting Each User’s Idibu ID

Settings > My Account > Idibu

Each user in Recruit So Simple that will be posting vacancies will need to set their Idibu User ID. This ID tells Idibu which user is posting a vacancy when done from within Recruit So Simple. From within your Idibu account, you can find the user IDs under [Configuration  > User Profiles]. Next to each user you will see the ID number listed, enter this number in Recruit So Simple.

Posting a Vacancy

Vacancy > Share

To post a vacancy, just head to the ‘Share’ screen inside the relevant vacancy record. Click the ‘Post to Idibu’ button and you will be taken to a screen that lists any Idibu job boards you’ve already posted to. Click the ‘Post Now’ button in the bottom-left and you will then be connected to Idibu’s job posting system. Some of the details from the vacancy record will be automatically shown, you can add and amend details as necessary and then post the vacancy.

Downloading Candidates

Candidates > Web Import

From the Web Import screen you can download candidate applications from your Idibu account. Click the ‘Download Idibu Applications’ button to start the download.

Note that when you download applications, the date and time of the download is stored in our system. On the next candidate download (by any consultant in Recruit So Simple), only new candidate applications received since the last download will be retrieved.

You can also choose to only download candidates with specific status colours from Idibu. The colours shown relate to the statuses inside Idibu. You can view and edit your Idibu statuses under [Configuration > System Set-up > Aptrack] inside their system.

The Data Feeds API can be used to connect Recruit So Simple with your website, Indeed, or other compatible job board. This allows you to post vacancies, to your website and your Indeed account, directly from the vacancy record’s Share screen.

The Data Feeds API is found in [Settings > System Settings > Web > Advanced].

JSON Data Feed, XML Data Feed

The JSON [c] and XML [b] data feeds provide structured vacancy data for your website. You can enable either or both, then share the feed URLs with your web developer to review. They can decide which fits best in your website environment, and integrate as needed.

Data	JSON	XML	XML/Indeed
Job Ref
Job title
Permanent or contract
Full-time / Part-time
Start date, end date
Job description
Consultant name
Consultant email address
Salary period
Salary
Currency
Additional salary info
Town/City
County
UK postcode or US ZIP code
Country
Client’s Business Area
Business Area ID
Question text
Question required
Tags ID
Tags name
Tag category
Date added (to the database)
Date posted
Client Ref
Vacancy URL (on micro Job Board)

Adding a vacancy to the feed

Add a vacancy to the JSON, XML, and the Indeed XML feed by enabling Data Feeds API, found under Sharing Options on a vacancy record’s Share screen.

Managing candidate applications

When using the JSON or XML feed to integrate with your website, your web developer can use our Data Posting API to send candidate applications to your database.

Candidate applications via the micro Job Board are automatically sent to your database – and you’ll be notified when that happens.

In both cases, candidate applications will appear in [Candidates > Web Import] where they can be reviewed and added to your database.

Connecting with Indeed

To share your vacancies with Indeed, follow the steps below.

1. Get Your XML Feed URL

Enable the Job Board Data Feed [a] in [Settings > System Settings > Web > Advanced].

https://rss.cm/job/x/xml

To make it compatible with Indeed, simply add /indeed the end, like this:

https://rss.cm/job/x/xml/indeed

2. Submit Your Feed to Indeed

Contact Indeed support and let them know you have an XML feed for your vacancies. Provide the Indeed-compatible feed URL above. They will guide you through the process of adding the feed to your account.

3. Set Up Your Micro Job Board

To ensure candidate applications reach your database, you should also enable your micro Job Board, which is included with your Recruit So Simple account.

For setup instructions, see our documentation: Job Board & Google Jobs. Your Job Board Data Feed (without the Indeed modification) [a] is the URL for your micro Job Board. You can use the link on your website, marketing and social media.

4. Enable Job Sharing on Vacancies

Once your feed is connected and your micro Job Board is set up:

• Open a vacancy record
• Go to the Share screen
• Enable both the Job Board and Data Feeds API

This will add the vacancy to your micro Job Board (allowing candidates to apply) and the Indeed XML feed to send the vacancy details to Indeed.

5. Receive Applications

When a candidate applies, their details will appear in [Candidates > Web Import], and you’ll be notified automatically.

Bonus Tip

If you’re manually posting vacancies on Indeed or editing existing ones:

• Look for an option to set a custom application URL
• Paste in the short URL shown on the vacancy’s Share screen (visible when the Job Board option is enabled on the vacancy record’s Share screen)

This links directly to your micro Job Board vacancy page, so candidates apply through your system. Candidate applications can be processed in [Candidates > Web Import].

The SMS Messaging module gives you the ability to send SMS messages to candidates, contacts and co-workers. All SMS messages sent from the system are deducted from your SMS credit balance.

Sender ID

The Sender ID [1]  is displayed on the phone when the message is received. This is a global setting that is applied to all messages sent from the system (unless a user has set their own custom Sender ID).

Sender ID pre-approval

Due to legislation aimed at preventing unsolicited messages, all custom sender IDs (phone numbers and company names) must be pre-approved by our network provider before they can be used. If you attempt to send an SMS without having your chosen sender ID pre-approved, the message may not be delivered.

You can request approval for your sender ID by opening a support ticket from [Dashboard > Help & Support], and letting us know what your preferred sender ID is.

Enable Custom Sender IDs

The Enable Custom Sender IDs [2] option allows users to set their own custom Sender ID rather than use the account’s default setting. If a number is used, users can receive replies (to messages that they send) to their own mobile phone. Custom IDs can be added from [Settings > My Account > SMS Settings]:

Note: US Telecommunications legislation prohibits the use of custom Sender IDs. If a custom Sender ID is used, it will be replaced with 43704 if sent to recipients in the US.

Ordering SMS Credits

Order more credits as you require [3]. If you have a zero credit balance you will not be able to send any SMS messages.

Credit Reminders

The Current Balance panel [4] will keep track of how many credits you have left and allows you to set an alert for when credits run low.

Composing an SMS Message

• 1 SMS credit is deducted per 150 characters.
• Maximum characters: 450 (3 credits)

You can send SMS Messages to candidates, contacts and other users. To add a recipient, start typing their name in the Add Recipient box [5]. Suggestions will start to appear while you type – simply select the name of the person you wish you message and they will be added to the list. Recipients must exist on your database, it’s not possible to add a mobile number to the ‘Add Recipient’ field.  The SMS message will be added as a journal to the relevant record when sent successfully. Templates [6] can be used to save time with frequently sent messages. SMS templates can be created from [Settings > System Settings > Email/SMS Templates]. Merge fields [7] are available to personalise messages when sending to multiple recipients. When using merge fields, remember that the recipient’s title and name will add characters to your message. The system will count characters as you type [8], so you’ll know how many credits you’ll use.

AI Writing Tools [9] allows you to select text and choose a writing style from: friendly, professional, concise, or key points. You can read about our other AI Tools here.

Bulk SMS messaging: There is a limit of 50 recipients per message to comply with anti-spam policies.

The Broadbean Integration module gives you the ability to post your jobs directly to Broadbean and import candidates directly into the system when they apply. This feature requires you to have a Broadbean account.

Visit www.broadbean.com

Configuring the Module

1. First you must email Broadbean’s technical support team asking them to allow us to integrate with your account. Send an email to support@broadbean.com (and CC support@recruitsosimple.com) with our API key (1224213688) and your company name, asking them to allow our API key to integrate with your Broadbean account.
2. Enter your Broadbean Admin username and password.
3. Each user will need to enter their own Broadbean username and password under [Settings > My Account > Broadbean].

Posting a Vacancy

Post vacancy to Broadbean from the vacancy’s Share screen.

Importing Candidates

Candidates > Web Import

1. Choose to only import candidates that you have marked as Suitable (you can flag candidates as suitable from your Broadbean control panel).
2. Click Download Broadbean Applications. All candidates that have applied via the selected job boards will appear here, ready for you to review and import.

Important: When the download button is clicked, all users’ candidates are imported (regardless of which user actions the download). This means that if someone goes in later and flags their candidates, only new applications since the last download will be imported. Candidates that were left in the previous download won’t be imported.

Best practice might be to establish an import policy, for example before anyone downloads from Broadbean ensure that all users have flagged their candidates first.

The Logic Melon Integration module gives you the ability to post your jobs directly to LogicMelon and import candidates directly into the system when they apply. This feature requires you to have a Logic Melon account.

Visit logicmelon.com

Configuring the Module

1. Enable the module and enter your Logic Melon administrator username and password under [Settings > System Settings > Job Boards]. The administrator account will be used for importing candidate applications for all users.
2. Each user will then need to enter their own Logic Melon username and password under [Settings > My Account > Logic Melon]. The user’s Logic Melon account will be used for posting vacancies.

Sharing a vacancy

1. Open a vacancy record and go to its Share screen.
2. Click Post to Logic Melon.
3. Click Post Now.
4. Select from your subscribed job boards. Note that at this point, you’re using Logic Melon as if you were logged in directly via their website. Important note: Do not change the Job reference, this is used to match the applicant to the correct vacancy.
5. Vacancy details will be automatically pulled through. Follow the steps as if logged in to your Logic Melon account.

Importing applications

1. Download applications from [Candidates > Web Import]. If you wish, you can flag candidates in Logic Melon first, and then choose which to download, for example, ‘Suitable’ and ‘Maybe Suitable’.
2. Delete an application or click Review to add a candidate to your database.

The download will be processed in the background and you can continue working. An alert will be generated when the download is finished.

The website integration allows you to display your vacancies on your website – just by including one line of code. Candidates can then register and their details automatically imported into the system after you have reviewed them.

Options:

1. Customise the colours to match the design of your website.
2. Candidate Registration allows visitors to apply for your vacancies.
3. Show or hide the search options widget.
4. Location is taken from the client’s Site address. County is displayed by default, but you can choose to use Town instead.
5. Require CV will ensure that candidates provide a CV with their registration.
6. Update the module to see changes in the Live Preview and on your website.

Registration Terms

You can enable registration terms to be displayed on the application page that candidates will see. This can be useful if you want to require the candidates to agree to any terms and conditions that you have. To enable this, head to [Settings > System Settings > Web > Advanced] and specify the text. This text will be shown next to a check box on the application page and candidates must check the box in order to apply. Once the candidate is added to the database, the registration terms will be included in the notes field on the candidate, this provides a permanent record of what they agreed to.

Adding To Your Site

The most common way to include the website integration, is to copy and paste the code [7] from the Integration Code section at the bottom of the page. There are more advanced options below should you wish to use them.

The API supports HTTPS (SSL) connections should you require this.

Sharing Vacancies

You can select which vacancies appear on your website under the ‘Share’ section (located under each vacancy) [1]. It will use the information from the Job Description (Website), Salary, Location and Permanent / Contract fields. The location will be based on the county of the client site that the vacancy is based at. If you wish to use the town instead, then click the “Use Town” option under the main module page. Closed vacancies will be automatically removed from your website.

When adding a new vacancy choose ‘Show On Website’ from the bottom of the Add Vacancy page.

Advanced Options

Show/Hide columns

To hide/show specific columns you can use the following code:

• https://api.recruitsosimple.co.uk/?action=webint&page=vacancies&key=[your_key_here]&cols=ref-pos-loc-typ-sal

To remove a column just remove the relevant shortcode. For example, to remove the ‘reference’ column, remove ‘ref’ from the code above. You can also remove the column headers by using the code ‘hidehead=1’

• You can modify the results returned by using the options below, however when using these, a basic list of jobs will be returned without any searching options. This is ideal for having a latest jobs feature on your website.

Limiting Results

To limit the number of results returned you can use the following code:

• https://api.recruitsosimple.co.uk/?action=webint&page=vacancies&key=[your_key_here]&limit=[number_here]

Results are always sorted by date, with the newest vacancies always appearing at the top.

Filtering By Tags

To only display vacancies that have specific tags assigned, you can use the following code:

• https://api.recruitsosimple.co.uk/?action=webint&page=vacancies&key=[your_key_here]&tags=[your_tag_id]

You can specify multiple tag IDs by separating them with dashes, each vacancy must have at least 1 of the specified tags in order to be displayed.

You can see the ID of a tag by editing the tag under [Settings > System Settings > Tags].

Candidate Registration

To link directly to the candidate registration page (so a candidate can register without applying for a specific job) then you can use the following code:

• https://api.recruitsosimple.co.uk/?action=webint&page=apply&key=[your_key_here]

If you don’t want the candidates to see a Continue button that redirects them to your vacancies list once their submission is successful, then you can add the applyOnly option:

• https://api.recruitsosimple.co.uk/?action=webint&page=apply&key=[your_key_here]&applyOnly=1

Modifying Links

If you require the vacancy detail pages to open outside of the iframe then you can use a URL Prefix. This will append a URL to the start of the API code. The examples on this page are written in PHP, but they can be re-written to work in any language you like.

In this example we have a page called job.php which contains the iframe code, and we want to open the details of a vacancy via a link from our home page. So we use the following code on the home page:

• https://api.recruitsosimple.co.uk/?action=webint&page=vacancies&key=[your_key_here]&prefix=http%3A%2F%2Fwww.yourwebsite.co.uk%2Fjobs.php%3Furl%3D

This will change all of the links to:

• https://www.yourwebsite.co.uk/jobs.php?url=[the_api_will_automatically_fill_this_part_in]

You must ensure that the address is URL Encoded (as above).

On your jobs.php page you then need to modify the iframe code to grab the ID of the vacancy:

• <iframe frameborder=”0″ scrolling=”auto” width=”100%” height=”500″ src=”<?php if(isset($_GET[‘id’])) { echo ‘https://api.recruitsosimple.co.uk/?action=webint&page=details&id=’.$_GET[‘id’].’&key=[your_key_here]’; } else { echo ‘https://api.recruitsosimple.co.uk/?action=webint&page=vacancies&key=[your_key_here]’; } ?>”></iframe>