Test endpoints
/authentication_test responds 200 only when the host, the API key and the signature are correct. Use GET to test a request without a body and POST to also test the payload_md5. How to build the headers: Authentication test.
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | — |
| Consultant | consultant-api | — |
| Assignor | assignor-api | — |
Base URL for each host: Environments (Hosts).
GET
ENDPOINT
/authentication_testMETHOD
GETNo body and no payload_md5 in the signature.
Response
STATUS
200{
"success": "Congrats!"
}
POST
ENDPOINT
/authentication_testMETHOD
POSTBody attributes
namestringrequiredAny text from 1 to 255 characters. The response returns the same value. The body does not accept other fields.{
"name": "QI Tech"
}
Response
STATUS
200{
"name": "QI Tech",
"success": "Congrats!"
}
Errors
| Status | Code | When it happens |
|---|---|---|
| 400 | QIT000001 | POST without name, with an empty name, with any field other than name or with a body that is not JSON. |
| 401 | *000008 | Invalid API key. It is almost always another profile's base URL. |
| 401 | *000016 | The signed payload_md5 does not match the bytes sent in the POST. |
The other signature errors are in Authentication errors.
Authentication, permission and host errors: see API errors.