#Getting started
This documentation is used by partners and clients of WiSE People Talent Solutions BV to connect their systems to ours.
Our current implementation involves features such as:
- - Connecting applicants of your applications to WiSE People.
API Keys
In order to access API endpoints, you must use an API key. Our API does not support sessions, so this key must be supplied with each request.
Request & Response Format
All requests are made using GET or POST methods. A POST method requires a JSON encoded object.
Date and time arguments will always be handled as being UTC+0.
Request Structure
JSON fields are handled case-insensitive. Thus no need to worry about that.
Response Structure
Our API responses contain the following structure:
- - Condition: A result condition returned by the API request. NOTE: This condition differs from the actual HTTP response codes. We always give a HTTP response 200 when you receive an answer from the API. This inner condition is the actual status.
- - Data: The result value. When no response data is expected, this value is NULL. Otherwise it will represent a defined object. This object is defined at the endpoint itself, thus allowing you to change the type of Data from object to a specified class.
- - Details: The result message. This message usually give more information about the condition.
- - IsDataCompressed: Currently not used.
- - Reflection: This element reflects on the request, given a reply as in which route was called, which the allowed parameters are and which you have provided.
Endpoints
The setup of the URL goes as follows:
DEVELOPMENT: https://api-office-development.wisepeople.be/api/__VERSION__/__API_KEY__/(...)
PRODUCTION: https://api-office.wisepeople.be/api/__VERSION__/__API_KEY__/(...)
API Usage Limitations
An API-key is limited to 100 API requests per minute. (Some webhooks are excluded)
Feedback
We value the feedback of our partners and clients. We want to provide a developer experience that allows for a seamless integration, but we need your help! If you have any suggestions, questions, comments, or ideas for our API, please contact support. (excl. support for examples in other coding languages)
Minimum SLA
95.833% (1h/day)
Example Body:
1
2
3
{
"ExampleEmail": "applicant@email.com"
}C# Example:
1
2
3
4
5
using (HttpClient client = new HttpClient())
{
HttpResponseMessage authResponse = await client.PostAsync(new Uri(__ENDPOINT__), new StringContent(JsonConvert.SerializeObject(new { __BODY__ }), Encoding.UTF8, MediaTypeNames.Application.Json));
ApiResponse response = JsonConvert.DeserializeObject<ApiResponse>(await authResponse.Content.ReadAsStringAsync());
}ApiResponse class:
1
2
3
4
5
6
7
8
public class ApiResponse
{
public int Condition { get; set; }
public object Data { get; set; }
public string Details { get; set; }
public bool IsDataCompressed { get; set; }
public object Reflection { get; set; }
}#Webhooks
#Applicant ApplicationPOST
Note:
This is a bulk call. Thus the body should be an array of elements, the endpoint gets executed one by one internally and returns on the first error it encounters.
See below for the non-bulk version for details on responses and POST body parameters.
Parameters (body):
BusinessData (Required)object
JobData (Required)object
UserData (Required)object
HTTP Status Code 200 ~ Condition Codes (response):
200A success result which also carries a response object.
261The request is accepted but the UserData ~ Email was marked invalid.
400An undocumented error has occured. A bug report has been logged, but we appreciate contacting us for providing more information.
401You are unauthorized to use this endpoint.
500HTTP Status Code 400 ~ An undocumented error happened. Please file an issue report HERE.
Body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"BusinessData": {
"Id": "12345678-abcd",
"Name": "WiSE People"
},
"JobData": {
"Id": "12345678-abcd",
"Name": "Developer",
"Recruiters": [
{
"Id": "12345678-abcd",
"Email": "recruiter@email.com",
"FirstName": "Jeff",
"LastName": "Doe",
"LanguageIso": "NL"
},
{
"...": ""
}
]
},
"UserData": {
"Id": "12345678-abcd",
"Email": "applicant@email.com",
"FirstName": "John",
"LastName": "Doe",
"LanguageIso": "NL"
}
}200 HTTP Status Code Response:
1
2
3
{
"Condition": 200
}#Close JobPOST
Note:
This is a bulk call. Thus the body should be an array of elements, the endpoint gets executed one by one internally and returns on the first error it encounters.
See below for the non-bulk version for details on responses and POST body parameters.
Parameters (body):
JobId(Required)string, intThe id on your system of the job which allows us to validate it to our database.
HTTP Status Code 200 ~ Condition Codes (response):
200A success result which also carries a response object.
400An undocumented error has occured. A bug report has been logged, but we appreciate contacting us for providing more information.
401You are unauthorized to use this endpoint.
500HTTP Status Code 400 ~ An undocumented error happened. Please file an issue report HERE.
Body:
1
2
3
{
"JobId": "12345678-abcd"
}200 HTTP Status Code Response:
1
2
3
{
"Condition": 200
}#Reject ApplicantPOST
Note:
This is a bulk call. Thus the body should be an array of elements, the endpoint gets executed one by one internally and returns on the first error it encounters.
See below for the non-bulk version for details on responses and POST body parameters.
Parameters (body):
JobId(Required)string, intThe id on your system of the job which allows us to validate it to our database.
ApplicantId(Required)string, intThe id on your system of the applicant which allows us to validate it to our database.
HTTP Status Code 200 ~ Condition Codes (response):
200A success result which also carries a response object.
400An undocumented error has occured. A bug report has been logged, but we appreciate contacting us for providing more information.
401You are unauthorized to use this endpoint.
500HTTP Status Code 400 ~ An undocumented error happened. Please file an issue report HERE.
Body:
1
2
3
4
{
"JobId": "12345678-abcd",
"ApplicantId": "12345678-abcd"
}200 HTTP Status Code Response:
1
2
3
{
"Condition": 200
}#Connect BusinessPOST
Parameters (body):
WisePeopleShortCode(Required)stringThe id on our system of the business which allows us to validate it to in our database.
HTTP Status Code 200 ~ Condition Codes (response):
200A success result which also carries a response object.
261The request is accepted but the WisePeopleShortCode was marked invalid.
400An undocumented error has occured. A bug report has been logged, but we appreciate contacting us for providing more information.
401You are unauthorized to use this endpoint.
500HTTP Status Code 400 ~ An undocumented error happened. Please file an issue report HERE.
Body:
1
2
3
{
"WisePeopleShortCode": "temp_store_11"
}200 HTTP Status Code Response:
1
2
3
{
"Condition": 200
}