How do I generate a URL to embed the Search Interface in my platform? – Affinda

Affinda's Search Interface has been designed to be easily customised and embedded within recruitment platforms and job boards. A customised and signed URL is generated by our API which can then be added securely to your platform as an iFrame.

Configuration

To configure the Search Interface that will be embedded, use the resume_search/config endpoint:

PATCH https://api.affinda.com/v1/resume_search/config
{
    "allowPdfDownload": true,
    "maxResults": null,
    "displayJobTitle": true,
    "displayLocation": true,
    "displayYearsExperience": true,
    "displayOccupationGroup": true,
    "displayEducation": true,
    "displaySkills": true,
    "displayLanguages": true,
    "displayManagementLevel": true,
    "displayKeywords": true,
    "weightJobTitle": 0.5,
    "weightLocation": 0.5,
    "weightYearsExperience": 0.5,
    "weightOccupationGroup": 0.5,
    "weightEducation": 0.5,
    "weightSkills": 0.5,
    "weightLanguages": 0.5,
    "weightManagementLevel": 0.5,
    "weightKeywords": 0.5,
    "indices": [],
    "searchToolTheme": null
}

The default searchToolTheme can be set at the account level and can then be overridden by the above request. To update your default theme, contact our team.

For more detail on customisations possible, see How can I customise the search interface?

Generating a URL

Then, to generate a resume search embed URL, use the resume_search/embed endpoint:

POST https://api.affinda.com/v1/resume_search/embed

Embedded URLs expire after 60 minutes. They will use the config set at the time when they are generated. That means if you change the config, you need to generate a new URL for the changes to be effective.

Optionally, you can override the config directly when generating a URL by including configOverride in the body:

{
    "configOverride": {...}
}