Guía de inicio de la API REST
HireHop está construido sobre una API, lo que significa que cualquier acción que vea realizar a HireHop también puede llevarla a cabo utilizando su extensa API. Todo lo que necesita para acceder a la API REST es un token de usuario aplicado como GET o POST al endpoint de URL correspondiente.
Tokens de API
Para generar un token de API, vaya a la página «Configuración» y seleccione la pestaña «Usuarios». Seleccione o cree un usuario y, con ese usuario específico seleccionado, haga clic en el botón «Menú» y luego en la opción «Token de API» para generar un token. El token se mostrará y se podrá copiar al portapapeles utilizando el botón de copiar.
El token dejará de ser válido si cambia el correo electrónico o la contraseña del usuario seleccionado, o si posteriormente inicia sesión con dicho usuario. Para evitar que esto suceda, debe crear un usuario de API dedicado y, por motivos de seguridad, asignarle los permisos pertinentes, restringiéndolo así de cualquier función para la que no vaya a utilizar la API.
Por razones de seguridad, nunca debe utilizar el token en código JavaScript de interfaz (front-end); solo debe usarse en el lado del servidor, ya que si un pirata informático obtiene el token, puede cambiar y acceder a sus datos en HireHop, así que mantenga su token en secreto. Si su token llega a filtrarse, simplemente cambie la contraseña del usuario de la API y genere un nuevo token.
Uso de un token
Un token debe establecerse como un parámetro GET o POST llamado “token”. Por ejemplo, para cargar los datos del trabajo número 52, HireHop llamará al punto final de la API:
https://myhirehop.com/php_functions/job_refresh.php?job=52
Si desea llamar al mismo punto final utilizando un token, la URL sería:
https://myhirehop.com/php_functions/job_refresh.php?job=52&token=dqwejk5GVT65909bHHBN7922pq5hxjm%207hmn
Recuerde que al pasar el token a través de GET (un parámetro de URL como el anterior), primero debe codificar el token utilizando una herramienta como Codificador/Decodificador de URL.
Envío de datos (POST)
Para crear o editar datos en HireHop debe utilizar un POST. Al enviar datos, solo debe configurar los campos que desea cambiar; por ejemplo, para crear o editar un trabajo utilizando el punto de acceso:
https://myhirehop.com/php_functions/job_save.php
Si configura el parámetro “job” en “0” o lo omite, se creará un nuevo trabajo; cualquier otro valor editará el número de trabajo correspondiente. Por lo tanto, para editar el nombre de la empresa en el trabajo número 52, los datos del post deben ser:
{
"job" : 52,
"name" : "New Name",
"token" : "dqwejk5GVT65909bHHBN7922pq5hxjm=-7hmn"
}
Puntos de acceso de la API
Muchos puntos de acceso de la API están documentados en la documentación de la API, y habrá muchos más próximamente. Para establecer el punto de acceso de una tarea en la aplicación de HireHop , utilice la consola de red del navegador para inspeccionar las llamadas de red y los parámetros configurados. Próximamente se publicará una guía completa sobre los puntos de acceso de URL.