Prerequisites
Account Config
For each partner account must be created
The account has a field config which is a Pipe-separated config string. On frontend GUI config is presented in user friendly editable table of field name / field value pairs. Field meanings are as following:
Field Name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
ver | Config version. Currently set to 1 | ||||||||
url | Notification endpoint supplied by partner. When the applicant completes questionnaire, the engine will issue POST or PATCH request to that endpoint. Application ID (64-bit integer) is added to this endpoint by one of the following methods:
| ||||||||
ext_notify | If present and equal to yes, extended information will be added to partner notification in json form. | ||||||||
auth | Any string that will be base64 encoded and added as a part of a standard Basic Authentication http header when sending request to notification endpoint. Partner must set up appropriate endpoint with the basic authorization. | ||||||||
rdc | Name of the reducer used for calculating main score for the applicant. | ||||||||
cmp | If present and equals 1 fields returned by Get Assessments command are encoded as a Pipe-separated config string Otherwise, fields will be returned as json array. If omitted the default value for cmp is 1. For partner requests value of cmp is ignored and fields are always returned as json array. | ||||||||
not_method | HTTP method used for partner notification
| ||||||||
not_headers | http headers to be added to the partner notification request. Encoded as a string of comma-separated headers and values in the form of header_1,value_1,...header_n,value_n. | ||||||||
not_sep | Character to use as separator in not_headers; defaults to comma if not set. | ||||||||
http_err | Comma-separated list of http status codes returned by partner when notifying their URL. |
User Config
For each Internal Partner account the user must be created. The user must have the following permissions:
account-member (8) with the corresponding account_id and with read access set to true
partner-std (16) with the corresponding account_id and with read, write and add access set to true
User name and password correspond to appropriate basic authorization fields of http request issued by partner.