accióntrabajo
red profesional | empleos | Estados Unidos
<

Documentación de la API

La API de acciontrabajo le permite a las empresas clientes la gestión de parte de las actividades que se pueden realizar en la plataforma de forma automátizada, es decir, sin necesidad de que un humano acceda al sistema para realizar las mismas.

Los usuarios con cuenta de empresa pueden publicar ofertas de empleo, editar empleos ya anunciados, activar, desactivar o borrar empleos existentes y descargar los datos de los postulantes que han presentado su candidatura a ofertas de empleo publicadas mediante la API.

Para realizar estas acciones se realizan peticiones via protocolo HTTPS a los distintos endpoints para cada una de ellas y con los parámetros indicados en esta documentación. Un endpoint es una dirección URL que acepta peticiones vía API.

El acceso a la API es posible para cualquier modo de cuenta para realizar pruebas, no obstante, las acciones solicitadas mediante la API sólo se ejecutan en cuentas que se encuentran en modo Standard o Premium, es decir, en modo no gratuito. Por lo tanto, es posible hacer el depurado de la implementación de la API en modo gratuito y pasar a modo Premium o Standard cuando el interface desarrollado por el cliente este listo para entrar en producción.

identificación

A cada empresa usuaria se le adjudica una ficha o token único que le identifica y que debe ser adjuntada en cada petición HTTPS realizada.

Si Ud. ha ingresado al sistema con sus credenciales le aparecerá a continuación ese token. Por favor, asegúrese de NO compartirlo con nadie ajeno a su organización pues da acceso a su cuenta de empresa sin necesidad de su email o password.

Su token es: you are not logged in

El token es enviado mediante un header de autentificación Bearer en cada petición realizada a cualquiera de los endpoints de la API.

La respuesta de un endpoint a una petición es enviada en formato JSON.

Por ejemplo Ud. puede realizar una petición de prueba mediante el comando curl así para consultar su modo de cuenta y créditos:

curl -H "Authorization: Bearer <token>" 'https://usa.acciontrabajo.com/api/business-quotas'

A continuación se describen los distintos tipos de peticiones que se pueden realizar mediante la API y los parámetros requeridos los cuales han de ser enviados mediante el método POST. Utilice el menú en esta documentación para acceder a la información relativa a cada endpoint y sus funcionalidades.

modo de cuenta y cuotas

Obtener información de la cuenta de empresa y cuotas disponibles.

Endpoint: https://usa.acciontrabajo.com/api/business/quotas

No se requieren parámetros.

Ejemplo de respuesta:

publicar empleos

La publicación de nuevos empleos y modificación de existentes se realiza a través del mismo endpoint.

Endpoint: https://usa.acciontrabajo.com/api/business/post-jobs

Para publicar un nuevo empleo se omite el parámetro "id".

Parámetros:

  • salary, opcional, salario, cifra en números.
  • sectors, opcional, entre 1 y 3 sectores. Consultar códigos. Si el sistema no es capaz de detectar un sector automáticamente el campo será obligatorio.
  • jobtitle, obligatorio, indica el título de la oferta de empleo, cadena de caracteres hasta 255.
  • experience, obligatorio, indica años de experiencia, número entre 1 y 20.
  • city, obligatorio indica ciudad donde se realizará el empleo, cadena de caracteres.
  • area, opcional, provincia o estado. Consultar códigos. Si el sistema no es capaz de detectar un sector automáticamente el campo será obligatorio.
  • email, obligatorio, email donde recibir las notificaciones de nuevas postulaciones.
  • contract, obligatorio, tipo de contrato ofrecido, consultar códigos.
  • description, obligatorio, descripción detallada de la oferta de empleo, cadena de caracteres.

Respuesta:

Al recibir la petición el endpoint le devuelve un mensaje indicando si la operación fue realizada corréctamente o hubo errores.

El formato del mensaje de respuesta es JSON y este es un mensaje tipo al enviar una petición sin ningún parámetro.

Un mensaje de publicación con éxito tendría una respuesta así:

lista de empleos publicados y archivados

Acceso a las ofertas de empleo publicadas o que se encuentran inactivas.

Endpoints:

https://usa.acciontrabajo.com/api/business/active-jobs , lista todos los empleos activos.

https://usa.acciontrabajo.com/api/business/archived-jobs , lista de todos los empleos archivados.

No se requieren parámetros de entrada.

activar, archivar o eliminar empleos


Gestionar los empleos ya existentes mediante su activación, archivo o borrado.

Endpoint: https://usa.acciontrabajo.com/api/business/job-status

Parámetros:

  • id, obligatorio, identifica a un anuncio de forma única.
  • status, obligatorio, valores: A -activar- ,D -archivar- ,X -eliminar-.

Lista de candidaturas recibidas a una oferta de empleo

Lista de los postulantes al empleo definido por su id.

Endpoint: https://usa.acciontrabajo.com/api/business/applications

Parámetros:

  • id, obligatorio, identifica a un anuncio de forma única.

ver candidatura

Acceder a un usuario que se ha postulado a una vacante.

Endpoint: https://usa.acciontrabajo.com/api/business/cv/<user_id>_<job_id>

Para acceder al endpoint de cada postulante puede hacer primero una peticion al endpoint de listar postulantes con el id del anuncio de empleo. Esto retornará una dirección url única para cada usuario y otros datos.