Extraer Datos de Empleo en Brasil

Copiar

• Copiar para LLM

  Copiar página como Markdown para LLMs
• Ver como Markdown

  Abrir esta página como Markdown
• Abrir en ChatGPT

  Obtener información de ChatGPT
• Abrir en Claude

  Obtener información de Claude

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

• Una visión general del flujo de datos
• Generar un token de acceso para el widget y crear un enlace
• Obtener información de empleo y del propietario

Requisitos previos

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 tu usuario crea exitosamente un enlace usando el Hosted Widget, 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 (ver las secciones moradas de WEBHOOK en el diagrama a continuación). Para que podamos notificarte una vez que los datos estén listos, necesitas proporcionar una URL a donde 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://production.belvo.com/api/token/ \
  -H 'Content-Type: application/json' \
  -H 'Host: production.belvo.com' \
  -d 'ver ejemplos de payloads abajo'

{
  "id": "YOUR_SECRET_ID",
  "password": "YOUR_SECRET_PASSWORD",
  "scopes": "read_institutions,write_links",
  "stale_in": "365d",
  "credentials_storage": "store",
  "fetch_resources": ["EMPLOYMENTS", "OWNERS"], 
  "widget": {
    "callback_urls": {
      "success": "your_deeplink_here://success",
      "exit": "your_deeplink_here://exit",
      "event": "your_deeplink_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/"
    },
    "theme": [] // See our dedicated widget customization article
  }
}

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 de access que recibiste de la solicitud /api/token/:

https://widget.belvo.io/
  ?access_token={access_code}
  &locale=pt
  &institutions=inss_br_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).

Webhook de espera de empleo

Tan pronto como se crea tu enlace, cargamos asincrónicamente la información de empleo disponible para el enlace y te enviaremos el siguiente webhook:

{
  "webhook_id": "03d1ca0d62db4f769488265d141047b7",
  "webhook_type": "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_employments": 1 // El número total de perfiles de registros 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/br/employments/?link={id}' \
-u SECRET_ID:SECRET_PASSWORD

Esperar el webhook del propietario

Tan pronto como se crea tu enlace, cargamos asincrónicamente la información del propietario disponible para el enlace y te enviaremos el siguiente webhook:

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

{
  "webhook_id": "aadf41a1fc8e4f79a49f7f04027ac999",
  "webhook_type": "OWNERS",
  "process_type": "historical_update",
  "webhook_code": "historical_update",
  "link_id": "16f68516-bcbc-4cf7-b815-c500d4204e28",
  "request_id": "4363b08b-51eb-4350-9c74-5df5ac92a7f6",
  "external_id": "your_external_id",
  "data": {
    "total_owners": 2 // Número total de propietarios
  }
}

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

curl --request GET 'https://api.belvo.com/api/owners/?link=link_id' \
-u SECRET_ID:SECRET_PASSWORD