Para realizar a integração com a nossa solução de avaliações, você precisa de uma chave de autenticação para efetuar as requisições relacionadas a uma área de trabalho.
O primeiro passo para iniciar a integração é entrar em contato com nosso suporte pelo e-mail [email protected] e solicitar a criação de uma conta em nosso ambiente de Sandbox com as configurações necessárias para que você possa realizar os testes de integração em um ambiente controlado.
Nossa equipe de atendimento irá apoiá-lo durante a integração.
Ambientes
Valor | Value |
Homologação | |
Produção |
Autenticação
Para que você consiga realizar as requisições, é preciso um custom header, exemplo:
Custom Header
Key | Value |
X-API-KEY | <Token> |
Content-Type | application/json |
Fluxograma
Entenda como funciona o fluxo da integração
Endpoints
Lista de avaliações
GET /assessments/ats
Lista de avaliações disponíveis na conta que realiza a requisição com a autorização.
Resposta
[
{
"offset":0,
"total":1,
"limit":150,
"payload":[
{
"assessment_id":"6707e51d867d313ecdd5f456",
"name":"AT - Integração",
"description":"Teste integração ATT",
"default_locale":"pt",
"duration":5,
"duration_unit":"hour",
"questions":[
{
"name":"Teste básico de lógica",
"description":"Crie uma classe que possa os métodos abaixo...",
"type":"freecoding",
"type_formatted":"Programação livre",
"level":"beginner",
"level_formatted":"Iniciante",
"duration":30,
"duration_unit":"minute"
},
{
"name":"Infraestrutura Multiusuários e Multitenant",
"description":"Solicitar ao candidato que desenhe e explique uma arquitetura...",
"type":"whiteboard",
"type_formatted":"Quadro branco",
"level":"advanced",
"level_formatted":"Avançado",
"duration":5,
"duration_unit":"hour"
}
]
}
]
}
]
Criar uma tentativa
POST /assessments/ats/attempts
Criar uma tentativa com a avaliação selecionada
{
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),
disable_email: (boolean, optional)
}Requisição
{
"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",
"disable_email": true
}
Resposta
{
"attempt_id": "66df68adc308c0ef4ee945f7",
"attempt_url": "https://beta.coodesh.com/pt/assessments/1725650303604?user_token=validToken"
}
Obter um resultado
GET /assessments/ats/attempts/{attemptId}
Obter o resultado de uma avaliação utilizando o identificador da tentativa
Resposta
{
"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",
"score": 6,
"score_type":"percentage",
"invited":"2024-09-26T18:47:50.185Z",
"started":"2024-09-26T18:47:50.179Z",
"updated":"2024-09-26T18:51:09.457Z",
"finished":"2024-09-26T18:50:25.575Z",
"public_link":"https://beta.coodesh.com/pt/share/assessments/66df68adc308c0ef4ee945f7?accessToken=NjZkZjY4YWRjMzA4YzBlZjRlZTk0NWY3MC43NzA0OTI1ODAxMTU1NzE1",
"provider_name":"Coodesh",
"provider_link":"https://beta.coodesh.com",
"results":[
{
"score": 6,
"title":"Fullstack Developer React.js",
"score_type":"percentage",
"date":"2024-09-09"
}
],
"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"
}WebHook
Para integrar os estados das tentativas de avaliação em seu sistema, você pode utilizar os seguintes status:
Iniciado (started): Indica que o colaborador iniciou a avaliação, mas ainda não a concluiu.
Expirado (expired): Significa que o prazo para a conclusão da avaliação foi ultrapassado sem que o colaborador a finalizasse.
Finalizado (finished): Aponta que o colaborador concluiu a avaliação e os resultados estão disponíveis.
A cada alteração no estado de uma tentativa, nosso sistema acionará o webhook_url fornecido durante a criação da tentativa, enviando os dados correspondentes ao novo estado.
Abaixo, apresentamos exemplos de objetos de dados correspondentes a cada estado:
Iniciado (started)
{
"title": "Frontend challenge 2024",
"status": "started",
"status_formatted": "Iniciado",
"invited": "2024-09-26T18:47:50.183Z",
"started": "2024-09-26T18:47:50.179Z",
"updated": "2024-09-26T18:51:09.457Z",
"provider_name": "Coodesh",
"provider_link": "https://beta.coodesh.com"
}
Expirado (expired)
{
"title": "Frontend challenge 2024",
"status": "expired",
"status_formatted": "Expirado",
"invited": "2024-09-26T18:47:50.183Z",
"started": "2024-09-26T18:47:50.179Z",
"updated": "2024-09-26T18:51:09.457Z",
"expired": "2024-09-26T18:50:25.575Z",
"provider_name": "Coodesh",
"provider_link": "https://beta.coodesh.com"
}
Finalizado (finished)
{
"title": "Frontend challenge 2024",
"status": "finished",
"status_formatted": "Finalizado",
"description": "Este é o resultado da sua avaliação Frontend challenge 2024",
"score": 6,
"score_type": "percentage",
"invited": "2024-09-26T18:47:50.183Z",
"started": "2024-09-26T18:47:50.179Z",
"updated": "2024-09-26T18:51:09.457Z",
"finished": "2024-09-26T18:50:25.575Z",
"public_link": "https://beta.coodesh.com/pt/share/assessments/66f5ac56ae3c56e39cbcd0c4?accessToken=NjZmNWFjNTZhZTNjNTZlMzljYmNkMGM0MC4xOTk3NzE5NzQzMzk3NDIzNg",
"provider_name": "Coodesh",
"provider_link": "https://beta.coodesh.com",
"results": [
{
"score": 6,
"title": "Frontend challenge 2024",
"score_type": "percentage",
"date": "2024-09-26"
}
],
"company_result_string": "Dexter Morgan obteve 6% de aproveitamento na avaliação Frontend challenge 2024.\nTestes:\n0% - Questão 1 - Questionário\n0% - Questão 2 - Programação\nEnviada em: 15:14 28 nov, 2024 GMT-03:00\nFinalizado em: 15:50 26 set, 2024 GMT-03:00\nRelatório: https://beta.coodesh.com/pt/share/assessments/66f5ac56ae3c56e39cbcd0c4?accessToken=NjZmNWFjNTZhZTNjNTZlMzljYmNkMGM0MC4xOTk3NzE5NzQzMzk3NDIzNg"
}Esses exemplos ilustram como os diferentes estados das tentativas de avaliação podem ser representados em seu sistema.
Códigos de Erro
400 - Bad Request
Dados enviados de forma incorreta ou fora do padrão.
401 - Unauthorized
Informe o token de autorização para realizar a requisição desejada.
403 - Forbidden
Sem autorização suficiente para acessar o recurso desejado.
429 - Too Many Requests
Limite máximo de requisições atingido.
500 - Internal Server Error
Indica erro de execução no servidor.