API for the Digital Robot System
Purpose
Getting Started: CONFIGURE API ACCESS
To be able to use the API for your deployment, you first need to login to the DIGITAL ROBOT system then go to System Settings > Integrations and switch Enable API to turn it on.
Once enabled, your API Authentication Key will be made visible. This key is validated on all calls to API endpoints.
PLEASE NOTE: If you believe that your API Key has been compromised, contact The Learning Resources Group and we can reset it for you.
AUTHENTICATION
When sending any request to the API we require the api key to be passed in a header parameter with key 'Authorization'.
| Key | Authorization |
| Value | ROBOT-V1-KEY apikey=”[API Authentication Key]” |
Example of header key as shown in a Postman request:
URL STRUCTURE - API ENDPOINTS
APIs endpoints are accessed via a standard URL structure;
| https://api.robot.online/api/[deployment]/v1/[resource] |
where the variables inside [ ] need to be replaced for the correct response.
| Parameter | Description |
|---|---|
| deployment | the deployment name that is assigned to the client to access the Digital Robot. This can be found in the URL used to access the system, e.g. if the URL is mycompany.robot.online, then the deployment variable would be mycompany |
| resource | the kind of resource information that you want to access from the system, in this case it is 'candidates' since we are accessing all the candidate information. |
Some endpoints may have required / option query string parameters. These are mentioned under each endpoint.
DATA FORMATS
The response from all APIs is a JSON document. At this time, JSON is the only format that we support, therefore you will need to take it into consideration when displaying the data.
STANDARD RESPONSE CODES
| Response Code | Definition |
|---|---|
| 200 | No Errors. Data should be fetched. |
| 400 | Bad Request. There is a mistake in the URL that you entered. Please check and make sure the version and the resource are spelt and placed correctly. |
| 401 | Unauthorized - wrong API Key or Deployment name. |
| 404 | Not Found. There is no deployment with that name. |
GET Candidates List
https://api.robot.online/api/deployment-name/v1/candidates
| https://api.robot.online/api/deployment-name/v1/candidates |
|
Authorization
|
ROBOT-V1-KEY apikey="" |
|
email
|
example: support@tlrg.com.au Optional - (String) Search by email address |
|
complete
|
example: false Optional - (Boolean) Search by result complete |
|
since
|
2019-01-01T00:00:00Z |
POST Candidate Invite
| https://api.robot.online/api/deployment-name/v1/candidates |
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
BODY urlencoded
|
testLevel
|
example: dp Required - (String) dp or dlrq Wherer test level |
|
email
|
example: suziem@myemail.com.au Required - (String) email address |
|
nameFirst
|
example: suzie Required - (String) |
|
nameLast
|
example: martin Required - (String) |
GET Courses
| https://api.robot.online/api/deployment-name/v1/digital-courses |
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
GET Jobs
| https://api.robot.online/api/deployment-name/v1/jobs |
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
GET Candidate Answer Report / Digital Profile
| https://api.robot.online/api/deployment-name/v1/candidate-answer-report?candidateId= |
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
| candidateId | Required -(String) Candidate Invite Code |
GET Candidate Comparisons List
| https://api.robot.online/api/deployment-name/v1/candidate-comparisons?candidateId= |
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
| candidateId | Required -(String) Candidate Invite Code |
POST Create Comparison
| https://api.robot.online/api/deployment-name/v1/candidate-create-comparison |
The "Creating Comparison Report" option via API is limited to one time only. If you want to create more comparisons you can login to your Digital Robot System.
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
| candidateId | Required -(String) Candidate Invite Code |
| type | example: job Required - (Enum: job, course) Comparison Type |
| id | example: 660a5979633a8d2cfd3c41a6 Required - (String) Course/Job Id |
GET Candidate Comparison Report
| https://api.robot.online/api/deployment-name/v1/candidate-comparison-report?candidateId=&id=65d6904cdcc885001296a35a |
HEADERS
|
Authorization
|
ROBOT-V1-KEY apikey="" |
| candidateId | Required -(String) Candidate Invite Code |
| id | example: 65d6904cdcc885001296a35a Required - (String) Comparison ID; from Candidate Comparisons List |
