Configure integration

Configure an order handling service URL

In order to allow our customers to use your services, you must configure URL to a service which accepts in-line assessment order requests. 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 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. Value passed in the Config object must match 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.