Use enrola's API from your own systems
enrola's application programming interface (API) lets your website and other systems work with your data. It has two parts:
- a public Opportunities feed, which needs no key, so your website can show your live vacancies in its own design;
- the rest of the API, which needs keys that a Team Owner creates, for reading and adding Applications, Opportunities, Employers and Contacts.
The full reference for your developers is at https://app.enrola.co.uk/api/doc/.
Show your vacancies on your website
Find your organisation's ID
Requests to the feed need your organisation's ID. Ask the enrola team for it, or open Settings → Organisation details and look at the number at the end of the web address in your browser.
List your live Opportunities
GET https://app.enrola.co.uk/api/v1/opportunities?organisation_id=123
This returns your live Opportunities that have been posted to your enrola job board. Unlike the job board itself, it includes every Opportunity type, whatever you've ticked under Published Opportunity Types in Settings → Website iFrame. It returns up to 5,000 at once, without paging. Each one includes its public ID (id), title, Opportunity type, dates, status, salary range, employer name, town, postcode and map coordinates.
Your developers can add:
| Parameter | What it does |
|---|---|
sort_by |
heading (the default) or start_from |
order |
asc (the default) or desc |
fulltext |
Only Opportunities matching this text |
Show one Opportunity
GET https://app.enrola.co.uk/api/v1/opportunities/detail/{id}
Use the public ID from the list. The answer includes the full description, requirements, training, skills, salary, duration, address and the NAS standard, plus an apply_url.
Link your Apply button to apply_url. Applicants then fill in your enrola application form, and their Applications are recorded as coming from your website.
Create API keys for your systems
Other requests need keys that belong to a user in your organisation. Only a Team Owner can create them.
- Open Settings → Users and open the user the keys are for.
- Select the Auth tab.
- In User OAuth details, select Generate new keys.
- Copy the Oauth 2.0 Id and Oauth 2.0 Secret and give them to your developer.
Warning. Selecting Generate new keys again replaces the user's keys. The old ones stop working straight away, so any system using them will need the new ones.
Your developer uses the keys to request an access token, which lasts 24 hours:
GET https://app.enrola.co.uk/api/v1/get-token?client_id=CLIENT_ID&client_secret=CLIENT_SECRET
They then send the token with each request in an Authorization: Bearer header.
What the keys give access to
| Records | What your systems can do |
|---|---|
| Opportunities | Add Opportunities. With a token, Opportunity details also include the number of Applications. |
| Applications | List and view Applications, list the custom fields they can carry, and add Applications, including a CV and file custom fields. |
| Employers and Contacts | View and add Employers, and list and add their Contacts. |
| Files | Download CVs and files from file custom fields. |
Keep the keys safe
- Keep the secret on your own server. Never put it in a web page or a mobile app, because anyone could read it there.
- The public feed needs no keys at all, so a website that only shows vacancies doesn't need them.
- The reference page's Test Request button sends real requests. On app.enrola.co.uk it changes your live data, so a test that adds a record really adds it.
Other ways to show vacancies
If you don't need your own design, the Website iFrame adds a complete job board with copy-and-paste code, and the RSS feed gives a simple list. See Add your Opportunities to your own website and Your Opportunities as an RSS feed.