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 puedas realizar las solicitudes, necesitas un encabezado personalizado, por ejemplo:

Encabezado personalizado

Llave	Valor
LLAVE X-API	<Ficha>
Tipo de contenido	aplicación/JSON

Diagrama de flujo

Comprender cómo funciona el flujo de integración

Extremos

Lista de reseñas

GET /assessments/ats

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

Respuesta

[
  {
    "offset": 0,
    "total": 1,
    "limit": 150,
    "payload": [
      {
        "assessment_id": "66db51bd1df871f6747fa6cb",
        "name": "Fullstack Developer React.js",
        "description": "Avaliação de exemplo de Integração",
      }
    ]
  }
]

Crear una evaluacion

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

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

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",
    "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"
        }
    ]
}

Códigos de error

400 - Mala solicitud

Datos enviados incorrectamente 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.