Extraer Registros de Empleo (Widget)

¿En México? Esta guía te guiará a través del proceso de usar nuestra API para extraer registros de empleo de manera segura y eficiente, permitiéndote verificar el empleo, entender el historial laboral y más.

Introducción

En esta guía, te guiaremos a través de todo lo que necesitas para extraer datos de empleo sobre tus usuarios utilizando nuestro widget. Esto incluye:

• Una visión general del flujo de datos
• Generación de un token de acceso para el widget y creación de un enlace
• Obtención de información de registros de empleo

Prerrequisitos

Antes de proceder con tu integración, asegúrate de haber revisado nuestra guía de inicio. En la guía de inicio, crearás una cuenta de Belvo, generarás algunas claves de API de sandbox y configurarás una URL de webhook. Para propósitos de prueba y desarrollo de tu integración, recomendamos encarecidamente usar el entorno de Sandbox siempre que sea posible.

Flujo general de datos

Belvo utiliza flujos de trabajo asincrónicos para mejorar tu flujo de datos (consulta el diagrama a continuación).

Cada vez que creas un enlace, Belvo extrae automáticamente todos los datos de empleo para ti en segundo plano, y una vez que tenemos todos los datos, te notificamos a través de un webhook que los datos están listos para ser recuperados. Para que podamos notificarte una vez que los datos estén listos, necesitarás proporcionar una URL a la que podamos enviar eventos.

Generar un token de acceso

Para que el widget aparezca a tus usuarios finales, necesitas generar un token de access en tu servidor y enviarlo a Belvo. Una vez que recibamos la solicitud, recibirás un objeto con dos claves: access y refresh. Pasa el valor de la clave access al iniciar el hosted widget.

Para generar un token de access, simplemente realiza una llamada desde tu servidor a Belvo:

curl -X POST \
  https://sandbox.belvo.com/api/token/ \
  -H 'Content-Type: application/json' \
  -d 'ver ejemplo de payload abajo'

{
  "id": "YOUR_SECRET_ID",
  "password": "YOUR_SECRET_PASSWORD",
  "scopes": "read_institutions,write_links",
  "stale_in": "365d",
  "credentials_storage": "store",
  "fetch_resources": ["EMPLOYMENT_RECORDS"],
  "widget": {
    "callback_urls": {
      "success": "your-url-here://success",
      "exit": "your-url-here://exit",
      "event": "your-url-here://error"
    },
    "branding": {
      "company_icon": "https://mysite.com/icon.svg",
      "company_logo": "https://mysite.com/logo.svg",
      "company_name": "ACME",
      "company_terms_url": "https://belvo.com/terms-service/",
      "overlay_background_color": "#F0F2F4",
      "social_proof": true
    },
    "theme": [] // Ver nuestro artículo dedicado a la personalización del widget
  }
}

{
  "access": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI3Mz...", 
  "refresh": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MjM0O...."
}

Inicia el widget en tu aplicación para tu usuario

A continuación, necesitarás redirigir a tu usuario al widget en una vista web dentro de tu aplicación, usando el token access que recibiste de la solicitud /api/token/:

https://widget.belvo.io/
	?access_token={access_code}
  &locale=mx
  &institutions=planet_mx_employment
  &access_mode=single
  &external_id=HJLSI-897809

Además, revisa nuestras secciones Iniciando el widget y eventos de callback de nuestra guía de Hosted Widget (Multi-Region).

Esperar un webhook y obtener datos de Registro de Empleo

Tan pronto como se crea tu enlace de empleo (para México), recuperamos de manera asincrónica los Registros de Empleo para el enlace y te enviamos el siguiente webhook:

En la carga útil del webhook incluimos el número de Registros de Empleo encontrados para el enlace.

{
  "webhook_id": "03d1ca0d62db4f769488265d141047b7",
  "webhook_type": "EMPLOYMENT_RECORDS",
  "process_type": "historical_update",
  "webhook_code": "historical_update",
  "link_id": "2f5d361d-dad6-45d4-a0bf-26d479766067",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "total_employment_record_profiles": 1 // El número total de perfiles de Registro de Empleo encontrados para el enlace
  }
}

Una vez que recibas la notificación, puedes obtener más detalles haciendo la siguiente solicitud:

curl --request GET 'https://api.belvo.com/api/employment-records/?link=link_id' \
  -u [Secret Key ID]:[Secret Key PASSWORD]

Esperar un webhook y obtener datos de Empleo Actual

Tan pronto como se crea tu enlace de empleo (para México), recuperamos de manera asincrónica los Empleos Actuales para el enlace y te enviamos el siguiente webhook:

En la carga útil del webhook incluimos el número de registros de Empleo Actual encontrados para el enlace.

{
  "webhook_id": "03d1ca0d62db4f769488265d141047b7",
  "webhook_type": "CURRENT_EMPLOYMENTS",
  "process_type": "historical_update",
  "webhook_code": "historical_update",
  "link_id": "2f5d361d-dad6-45d4-a0bf-26d479766067",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "total_current_employments": 1 // El número total de registros de Empleo Actual encontrados para el enlace
  }
}

Una vez que recibas la notificación, puedes obtener más detalles haciendo la siguiente solicitud:

curl --request GET 'https://api.belvo.com/api/mx/current-employments/?link=link_id' \
  -u [Secret Key ID]:[Secret Key PASSWORD]