- Integración de API
- API Endpoint
- Autenticación
- Agregar un nuevo Candidato
- Consultar Candidato
- Consultar Listado de Candidatos
- Consultar reporte PDF
- Consultar reporte PDF de una prueba en específico
- Errores
Integración de API
El API de Psicométricas está diseña sobre REST, por lo tanto encontrarás que las URL están orientadas a recursos y se usa códigos de respuesta HTTP para indicar los errores en la API. Todas las respuestas de la API están en formato JSON, incluyendo los mensajes de error.
API Endpoints
Usa las credenciales que se generaron al momento de tu registro para realizar la integración de tu sistema con Psicométricas. Las siguientes URIs forman la base de los endpoints:
URI base: https://admin.psicometricas.mx/api/
Autenticación
Para realizar peticiones a la API de Psicométricas es necesario enviar el Token (API Clave) y la contraseña en todas las llamadas a nuestro servidor.
Por razones de seguridad todas las peticiones deben ser vía **HTTPS**.
Agregar un nuevo Candidato
Método: POST
URL:
https://admin.psicometricas.mx/api/agregaCandidato
| Parámetro | Descripción |
| Token | string (requerido, longitud = 20) |
| Password | string (requerido, longitud = 20) |
| Candidate | string (requerido, longitud = 200) Nombre(s) del candidato |
| string (requerido, longitud = 100) Cuenta de correo electrónico del Candidato | |
| Vacancy | string (requerido, longitud = 100) Nombre de la vacante |
| Tests | string (requerido, longitud = 100) Listado de pruebas separadas por comas (Ejemplo: 1,2,3) |
| Listado de pruebas disponibles | |
| Pruebas | Nombre |
| 1 | Cleaver |
| 2 | Kostick |
| 3 | IPV |
| 4 | LIFO |
| 5 | Zavic |
| 7 | Terman |
| 9 | Ingles |
| 10 | 16PF |
| 11 | Barsit |
| 15 | Moss |
| 16 | Wonderlic |
Ejemplo de petición
https://admin.psicometricas.mx/api/agregaCandidatoParámetros en POST
Token ->
Valor generado en la creación de la cuenta
Password -> Contraseña
Candidate -> Nombre del candidato
Email -> [email protected]
Vacancy -> Vacante a la que aplica
Tests -> 1, 2, 3
Ejemplo de respuesta
{
"status" : "200",
"clave" : "1-EUPQ-0116-164",
"msg" : ""Candidato agregado correctamente."
}
Consultar Candidato
Método: GET
URL:
https://admin.psicometricas.mx/api/consultaCandidato
| Parámetro | Descripción |
| Token | string (requerido, longitud = 20) |
| Password | string (requerido, longitud = 20) |
| Clave | string (requerido, longitud = 200) Clave del candidato |
Ejemplo de petición
https://admin.psicometricas.mx/api/consultaCandidatoParámetros en GET
Token ->
Valor generado en la creación de la cuenta
Password -> Contraseña
Clave -> 1-GABF-0110-2220
Ejemplo de respuesta
{
"clave": "1-GABF-0110-2220",
"nombre": "Nombre del candidato",
"correo_ele": "[email protected]",
"vacante": "sistemas",
"fecha": "2020-01-10 16:20:15",
"id_prueba": 2,
"nombre_prueba": "Kostick",
"estatus": 2,
"fecha_fin": null,
"status_practica": 0
}
Consultar Listado de Candidatos
Método: GET
URL:
https://admin.psicometricas.mx/api/consultaCandidato
| Parámetro | Descripción |
| Token | string (requerido, longitud = 20) |
| Password | string (requerido, longitud = 20) |
Ejemplo de petición
https://admin.psicometricas.mx/api/consultaCandidatoParámetros en GET
Token ->
Valor generado en la creación de la cuenta
Password -> Contraseña
Ejemplo de respuesta
{
"clave": "1-GABF-0110-2220",
"nombre": "Nombre del candidato",
"correo_ele": "[email protected] ",
"fecha": "2020-01-10 16:20:15",
"vacante": "sistemas",
"estatus": 1
},
{
"clave": "1-VCFS-0110-2225",
"nombre": "Nombre de candidato",
"correo_ele": "[email protected]",
"fecha": "2020-01-10 16:25:59",
"vacante": "Test",
"estatus": 1
}
Consultar reporte PDF
Método: GET
URL:
https://admin.psicometricas.mx/api/consultaResultado
| Parámetro | Descripción |
| Token | string (requerido, longitud = 20) |
| Password | string (requerido, longitud = 20) |
| Clave | string (requerido, longitud = 200) |
Ejemplo de petición
https://admin.psicometricas.mx/api/consultaResultadoParámetros en GET
Token ->
Valor generado en la creación de la cuenta
Password -> Contraseña
Clave -> 1-VCFS-0110-2225
Ejemplo de respuesta
Devuelve el archivo PDF del resultado
Consultar reporte PDF de una prueba en específico
Método: GET
URL:
https://admin.psicometricas.mx/api/consultaResultado
| Parámetro | Descripción |
| Token | string (requerido, longitud = 20) |
| Password | string (requerido, longitud = 20) |
| Clave | string (requerido, longitud = 200) |
| Prueba | Integer (requerido, longitud = 2) Numero de la prueba a consultar |
Ejemplo de petición
https://admin.psicometricas.mx/api/consultaCandidatoParámetros en GET
Token ->
Valor generado en la creación de la cuenta
Password -> Contraseña
Clave -> 1-VCFS-0110-2225
Prueba -> 1
Ejemplo de respuesta
Devuelve el archivo PDF del resultado
Errores
PsicometricasMx regresa objetos de JSON en las respuestas del servicio, incluso en caso de errores por lo que cuando exista un error.
Códigos de error
Agregar Candidato
| Codigo | Error HTTP | Causa |
| 1001 | 401 - Accesos incorrectos | El token o la contraseña son incorrectos para el usuario |
| 1002 | 402 - Actualmente no cuenta con un paquete activo | La cuenta no tiene un paquete activo, se debe realizar una contratación para las peticiones |
| 1003 | 409 - El paquete activo no es compatible con el API | Se cuenta con un paquete activo, pero para utilizar el API se requiere la activación de un paquete compatible. |
| 1004 | 422 - Todos los valores son obligatorios | Todos los valores son obligatorios y se debe enviar la información para el alta del candidato. |
Consultar Candidato
| Codigo | Error HTTP | Causa |
| 1001 | 401 - Accesos incorrectos | El token o la contraseña son incorrectos para el usuario |
| 1002 | 402 - Actualmente no cuenta con un paquete activo | La cuenta no tiene un paquete activo, se debe realizar una contratación para las peticiones |
| 1003 | 409 - El paquete activo no es compatible con el API | Se cuenta con un paquete activo, pero para utilizar el API se requiere la activación de un paquete compatible. |
Consultar listado de candidatos
| Codigo | Error HTTP | Causa |
| 1001 | 401 - Accesos incorrectos | El token o la contraseña son incorrectos para el usuario |
| 1002 | 402 - Actualmente no cuenta con un paquete activo | La cuenta no tiene un paquete activo, se debe realizar una contratación para las peticiones |
| 1003 | 409 - El paquete activo no es compatible con el API | Se cuenta con un paquete activo, pero para utilizar el API se requiere la activación de un paquete compatible. |
Consultar resultado en PDF
| Codigo | Error HTTP | Causa |
| 1001 | 401 - Accesos incorrectos | El token o la contraseña son incorrectos para el usuario |
| 1002 | 402 - Actualmente no cuenta con un paquete activo | La cuenta no tiene un paquete activo, se debe realizar una contratación para las peticiones |
| 1003 | 409 - El paquete activo no es compatible con el API | Se cuenta con un paquete activo, pero para utilizar el API se requiere la activación de un paquete compatible. |