Para integrarse con nuestra solución de evaluación, necesita una clave de autenticación para realizar solicitudes relacionadas con un espacio de trabajo.

El primer paso para iniciar la integración es ponerse en contacto con nuestro soporte en [email protected] correo electrónico y solicitar la creación de una cuenta en nuestro entorno Sandbox con los ajustes necesarios para que puedas realizar las pruebas de integración en un entorno controlado.

Nuestro equipo de servicio le apoyará durante la integración.

Entornos

Valor	Valor
Homologación	https://api.beta.coodesh.com
Producción	https://api.coodesh.com

Autenticación

Para que pueda realizar las solicitudes, necesita un encabezado personalizado, por ejemplo:

Encabezado personalizado

Llave	Valor
X-API-KEY	<Token>
Content-Type	application/json

Diagrama de flujo

Comprender cómo funciona el flujo de integración

Extremos

Lista de evaluaciones

GET /assessments/ats

Listado de evaluaciones disponibles en la cuenta que realiza la solicitud con la autorización.

Respuesta

[
   {
      "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"
               }
            ]
         }
      ]
   }
]

Crear una intento de evaluación

POST /assessments/ats/attempts

Crear un intento con la evaluación seleccionada

{
    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)
}

Requisición

{
    "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
}

Respuesta

{
    "attempt_id": "66df68adc308c0ef4ee945f7",
    "attempt_url": "https://beta.coodesh.com/pt/assessments/1725650303604?user_token=validToken"
}

Obtener un resultado

GET /assessments/ats/attempts/{attemptId}

Obtener el resultado de una evaluación mediante el identificador de intento

Respuesta

{
   "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=validToken"
}

WebHook

Para integrar los estados de los intentos de evaluación en el sistema, puede utilizar los siguientes estados:

Comenzó: Indica que el empleado ha iniciado la evaluación, pero aún no la ha completado.
Caducado: Significa que se ha superado el plazo para completar la evaluación sin que el empleado la haya completado.
Terminado: Señala que el empleado ha completado la evaluación y los resultados están disponibles.

Con cada cambio en el estado de un intento, nuestro sistema activará el webhook_url proporcionado durante la creación del intento, enviando los datos correspondientes al nuevo estado.

A continuación se muestran ejemplos de objetos de datos correspondientes a cada estado:

Comenzó (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"
}

Caducado (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"
}

Terminado (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"
}

Estos ejemplos ilustran cómo se pueden representar los diferentes estados de los intentos de prueba en el sistema.

Códigos de error

400 - Mala solicitud

Datos presentados de forma incorrecta o fuera de estándar.

401 - No autorizado

Introduzca el token de autorización para realizar la solicitud deseada.

403 - Prohibido

No está lo suficientemente autorizado para acceder al recurso deseado.

429 - Demasiadas solicitudes

Límite máximo de solicitudes alcanzadas.

500 - Error interno del servidor

Indica un error de ejecución en el servidor.