We strongly recommend the client/site owner and the website developer discuss and agree on the website specification before signing any development contract with Broadbean.
These are the requirements your API should meet in order for us to be able to integrate with it.
Overview
We have 2 main types of integration:
- We send advert data to an end-point defined and hosted by you. Referred to as an Instant feed.
- You fetch advert data from an end-point defined and hosted by Broadbean. Referred to as a Batch On-Demand feed.
Instant Feed - Requirements
Your API must fulfil the following requirements:
- It must have only HTTPS end-points.
- Accept one advert per transaction.
- Be multi-threaded / thread-safe as we may make concurrent transactions.
- After an advert is sent to your API, we require you to return a clear success message. For example, "advert has been posted successfully".
- Nice to have: After an advert is sent your API returns the advert URL as well as the success message.
- Each advert transaction must be able to handle a new, unique email address or URL (Aplitrak). The email address/URL provided will be job-specific. Please read about Aplitrak.
- Email Application: Applications have to come from a unique applicant email address which can be sent in the "From" or "Reply-To" email header field. Otherwise, applications from the same email address will be de-duplicated.
- In the event of an advert posting failure, your API must send a meaningful response. Examples include "Username/Password not recognised", "Insufficient credit". We will then be able to map your error codes to our user-facing messages.
- The advert data will be sent to your API end-point in one of the supported formats: XML, JSON or URL encoded. Please see examples here.
Please familiarise yourself with the typical feed configuration here first then submit your technical specification here.
Batch On-Demand Feed - Requirements
Your API must fulfil the following requirements:
- Fetch adverts on a chosen frequency from our end-point.
- For Job Boards: there has to be a node in the advert structure to identify what client the advert belongs to. Example, <company>Test Recruitment Agency</company>
- Accommodate delete functionality: Broadbean will delete the XML advert data from the provided URL after a client sends a delete request.
- Each advert must be able to handle a new, unique email address or URL (Aplitrak). The email address/URL provided will be job-specific. Please read about Aplitrak.
- Email Application: Applications have to come from a unique applicant email address which can be sent in the "From" or "Reply-To" email header field. Otherwise, applications from the same email address will be de-duplicated.
- The advert data provided will be in one of the supported formats: XML or JSON. Please see examples here.
Please familiarise yourself with the typical feed configuration here first then submit your technical specification here.