Configure integration

šŸ›‘

Assessment API Sunset

This API has been deprecated since September 4, 2023. The sunset date is May 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

Configure an order handling service URL

In order to allow our customers to use your services, you must configure the URL to a service that accepts in-line assessment order requests. The URL must not contain a query string. You can register the URL by sending the Config object on the /configs endpoint. Please note that the Config object needs to have an ā€œinlineAssessmentOrderUrlā€ id.

Here is the POST request for URL configuration:

curl -i
     -H "X-SmartToken:abc123"
     -H "Content-Type: application/json;charset=utf-8"
     -d @body.json
     -X POST
     https://api.smartrecruiters.com/v1/configs

body.json:

{
    "id": "inlineAssessmentOrderUrl",
    "value": "http://api.partnercompany.com/inline-assessments/orders"
}

If there is a change in the URL, another POST request containing the updated value needs to be sent.

Configure an authentication header

Along with the URL you can also configure the authentication header which will be passed when making a call to your order handling service. You can register the header by sending the Config object on the /configs endpoint. Please note that the Config object needs to have an inlineAssessmentOrderHeader ID. The value passed in the Config object must match the pattern headerName:headerValue.

Here is the POST request for header configuration:

curl -i
     -H "X-SmartToken:abc123"
     -H "Content-Type: application/json;charset=utf-8"
     -d @body.json
     -X POST
     https://api.smartrecruiters.com/v1/configs

body.json:

{
    "id": "inlineAssessmentOrderHeader",
    "value": "X-Token:secret"
}

If there is a change in the header, another POST request containing the updated value needs to be sent.