Bean Widgets is a lightweight JSON API used to integrate a variety of Veritone Hire 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 Veritone Hire functionality quickly and efficiently.
Each client will be provided with an API key and Secret key for connecting with the Veritone Hire system to send the API request. Bean Widgets API uses passwordless authentication i.e., all API calls use a unique signature generated with a secret key provided to each client.
The signature is generated using the secret key to create a hash of a signature message composed of the AdCourier Username, the time the signature was generated (measured in milliseconds since the epoch) and the API Key of the party who are generating the signature.
We need to consider six key areas for any integration:
-
User Mapping - It is recommended to use the one-to-one mapping, so each user in your system should be able to enter their Veritone Hire username for communicating with the Veritone Hire system.
-
Publish - Post plus Dashboard API call will give you access to advert posting and manage advert dashboard (if the advert has been published before).
-
Status - This is to track the status of posted advert on individual job boards. This is available through the Manage Advert Dashboard, notify on delivery and via advert status API.
-
Delete - When a job is closed in your system, you can delete the posted advert through manage advert dashboard or via API call. Manage advert dashboard allows global and channel level delete.
-
Source Tracking - For all clients/partners using the apply online workflow, where Apply Online URL is passed with posting API call source tracking is mandatory. We will append a source parameter to the supplied Apply Online URL. For more information regarding source tracking, check the Automatic Source Tracking section of this document.
-
Response - For clients using email apply or quick apply workflow, response will be sent to ATS/CRM system through our candidate Hub. To learn how to receive candidates from Veritone Hire, check the Candidate Hub Integration section of this document.