To integrate with our assessment solution, you need an authentication key to make requests related to a workspace.
The first step to start the integration is to contact our support at [email protected] email and request the creation of an account in our Sandbox environment with the necessary settings so that you can perform the integration tests in a controlled environment.
Our service team will support you during the integration.
Environments
Value | Value |
Homologation | |
Production |
Authentication
In order for you to be able to make the requests, you need a custom header, for example:
Custom Header
Key | Value |
X-API-KEY | <Token> |
Content-Type | application/json |
Flow chart
Understand how the integration flow works
Endpoints
List of assessments
GET /assessments/ats
List of assessments available in the account that makes the request with the authorization.
Answer
[
{
"offset": 0,
"total": 1,
"limit": 150,
"payload": [
{
"assessment_id": "66db51bd1df871f6747fa6cb",
"name": "Fullstack Developer React.js",
"description": "Avaliação de exemplo de Integração",
}
]
}
]
Create an attempt
POST /assessments/ats/attempts
Create an attempt with the selected assessment
{
email (string, required),
name (string, required),
user_id (string, required),
assessment_id (string, required),
company_id (string, required),
job_id (string, required),
callback_url (string, required),
webhook_ul (string, required),
}Request
{
"email": "[email protected]",
"name": "Glaydston User 24",
"user_id": "b12002e0-afc4-11ee-ac51-1fb9ace11428",
"company_id": "d5cf6e60-f2f5-11e7-9747-838fbc80281c",
"assessment_id": "66db51bd1df871f6747fa6cb",
"job_id": "54046020-aec4-11ee-a01d-174ac5115722",
"callback_url": "https://empresa.seuats.com",
"webhook_url": "https://api.seuats.com"
}Answer
{
"attempt_id": "66df68adc308c0ef4ee945f7",
"attempt_url": "https://beta.coodesh.com/pt/assessments/1725650303604?user_token=validToken"
}Get a result
GET /assessments/ats/attempts/{attemptId}
Get the result of an assessment using the attempt identifier
Answer
{
"title": "Fullstack Developer React.js",
"status": "invited",
"status_formatted": "Convidado",
"stage": "none",
"stage_formatted": "Sem avaliação",
"description": "Este é o resultado da sua avaliação Fullstack Developer React.js",
"company_result_string": "User 24 obteve 0% de aproveitamento na avaliação Fullstack Developer React.js.\nTestes:\n\nEnviada em: 18:30 09 set, 2024 GMT-03:00\nFinalizado em: 18:30 09 set, 2024 GMT-03:00\nRelatório: https://beta.coodesh.com/pt/share/assessments/66df68adc308c0ef4ee945f7?accessToken=NjZkZjY4YWRjMzA4YzBlZjRlZTk0NWY3MC43NzA0OTI1ODAxMTU1NzE1",
"providerName": "Coodesh",
"providerLink": "https://beta.coodesh.com",
"results": [
{
"tier": "major",
"score": 0,
"title": "Fullstack Developer React.js",
"type_result": "percentage",
"date": "2024-09-09"
}
]
}Error Codes
400 - Bad Request
Data submitted incorrectly or out of standard.
401 - Unauthorized
Enter the authorization token to make the desired request.
403 - Forbidden
Not authorized enough to access the desired resource.
429 - Too Many Requests
Maximum limit of requests reached.
500 - Internal Server Error
Indicates execution error on the server.