Skip to main content

Key Concepts

Please refer to the below as your basic point of reference during the development process.

Terminology

Before diving into the API, it's essential to understand these core concepts:

  • Partner: a whitelabel partner or any other type of 3rd-party system utilizing idibu's API. That's you!
  • Client: a recruitment company account. A single Partner can manage multiple Clients.
  • Office: used to identify the company's branch or other entity used to group Teams. A single Client can have multiple Offices.
  • Team: used to identify the company's sub-branch or other entity used to group Users. A single Office can have multiple Teams.
  • User: sometimes referred to as "Sender" or "Profile" - the consultant posting a Job and managing Applicants. A single Client or Team (but not Office) can have multiple Users.
  • Job: core vacancy information - like title, description, location, or salary - stored as the main object in the system.
  • Portal: a posting destination (job board, aggregator, recruitment website, or social media site), also often referred to as "Board".
  • Post: every single interaction - like posting, updating, or deleting a job - with every single Portal. A single Job can have multiple Posts.
  • Posting Queue: idibu's automated queue that stores all currently pending Posts and handles sending them to Portals.
  • Core Fields: standard set of fields (title, description, location, salary, and more) that make up the Job in the idibu system, used universally on most Portals.
  • Extra Fields: fields unique to a specific Portal.
  • Applicant: a single instance of a candidate, tied to a Post (and, by extension, Job) and a Portal.
  • Job Posting API (you are here!): a set of methods and concepts meant to create and manage Jobs and their Posts.
  • Webservices: a set of REST methods to list, manage, and interact with various objects on the Client account (including Applicants, Jobs, Users, Portal subscriptions, and more), as well as adjust settings.
  • UPP - the Universal Posting Page that, together with the PCP, allows to quickly and easily generate an out-of-the-box embeddable HTML interface. If you are using the Job Posting API, you are therefore not using the UPP.
  • PCP - the Post Completion Page is an HTML interface that is meant to constitute the final step of posting where the user selects Portals and fills in their individual Extra Fields. It is generated if you don't provide enough Portal-specific information to successfully perform a Direct Posting.
  • Direct Posting - a concept of full, "360" API integration that requires the Partner to fully manage the posting process and the UI, allowing more control and flexibility. If you follow the Direct Posting workflow, you are therefore not using the UPP or PCP; in fact, generating a Post Completion Page in the API response will most likely constitute an error for you.

Date and time

All date and time values returned or required by this API and webservices are always in London time (which is the same as GMT+0 during winter; and GMT+1 while adjusted to British Summer Time).