Bean Widgets is a lightweight JSON API used to integrate a variety of Broadbean functionality into ATS and CRM systems using simple widgets.
It supports Posting, Job Post Dashboard, Search and Advert Responses management and is targeted at partners who want to deploy the core Broadbean functionality quickly and efficiently. All users will be supplied with an API Key and a secret key or encryption token for each client they act on behalf of.
There are several key concepts common to each call:
-
Identification node
-
client_id - An AdCourier Client ID
-
adc_username - Broadbean AdCourier username of ATS user
-
Authentication node
-
api_key - a Broadbean API access token (contact Broadbean Client Support for more details)
-
time - the current epoch time in milliseconds
-
signature - an HMAC SHA256 hex digest of the following string: sprintf( "%s|%s|%s", ADC-USERNAME, TIME, API-KEY), using the CLIENT-SECRET-KEY - e.g. hmac_sha256_hex( adc_username + '|' + time + '|' + api_key )
-
Filters
-
All vacancies on Broadbean are identified using filters
-
It is strongly recommended that these are custom fields supplied for each vacancy posted
-
The custom fields should be a unique identifier (or identifiers) of the vacancy in the ats.