Extrair Registros de Emprego (API)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

Procurando acessar dados de histórico de emprego para seus usuários no México? Este guia irá orientá-lo no processo de usar nossa API para extrair registros de emprego de forma segura e eficiente, permitindo que você verifique o emprego, entenda o histórico de carreira e muito mais.

Introdução

Neste guia, vamos orientá-lo em tudo o que você precisa para extrair dados de emprego sobre seus usuários usando nossa API. Isso inclui:

• Uma visão geral do fluxo de dados
• Criando um link (via API)
• Obtendo informações de registros de emprego históricos
• Obtendo informações de registros de emprego atuais

Pré-requisitos

Antes de prosseguir com sua integração, certifique-se de que você leu nosso guia de introdução. No guia de introdução, você criará uma conta Belvo, gerará algumas chaves de API sandbox e configurará uma URL de webhook. Para fins de teste e desenvolvimento de sua integração, recomendamos fortemente o uso do ambiente Sandbox sempre que possível.

Fluxo geral de dados

A Belvo utiliza fluxos de trabalho assíncronos para melhorar o fluxo de dados (veja o diagrama abaixo).

Sempre que você cria um link, a Belvo automaticamente extrai todos os dados para você em segundo plano, e assim que temos todos os dados, notificamos você via um webhook que os dados estão prontos para serem recuperados.

Criar um link

Para criar um link, você só precisa fazer a seguinte solicitação POST Register a new link:

curl --location 'https://sandbox.belvo.com/api/links/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic BASE64(SECRET_ID:SECRET_PASSWORD)' \
--data '{veja exemplos abaixo}'

{
  "institution": "planet_mx_employment",
  "username": "BLPM951331IONVGR54",
  "fetch_resources": ["EMPLOYMENT_RECORDS"],
  "access_mode": "single",
  "external_id":"COHORT_32_User_6790023X5"
}

{
    "id": "74c01cb4-edf1-44d6-8876-b1dc2aebcb14", 
    "institution": "planet_mx_employment", 
    "access_mode": "single",
    "status": "valid",
    "refresh_rate": null,
    "created_by": "6e9be884-4781-4143-b673-aca02475ee8c",
    "last_accessed_at": "2024-06-26T16:25:54.344113Z",
    "external_id": "COHORT_32",
    "created_at": "2024-06-26T16:25:54.334413Z",
    "institution_user_id": "BidIxnZkKvQx0_F0oSYVx6Jnsh4Zmoat2ot2iOoG018=",
    "credentials_storage": "365d",
    "stale_in": null,
    "fetch_resources": [
        "EMPLOYMENT_RECORDS",
        "CURRENT_EMPLOYMENTS"
    ]
}

Erros comuns ao criar um link

Ao criar um link com o IMSS México, você pode receber erros específicos devido ao CURP que você fornece. Abaixo você pode ver alguns erros comuns junto com as explicações de por que eles ocorrem.

Aguarde um webhook e obtenha dados de Registro de Emprego

Assim que seu link de emprego (para o México) for criado, recuperamos assincronamente os Registros de Emprego para o link e enviamos o seguinte webhook:

No payload do webhook, incluímos o número de Registros de Emprego encontrados para o link.

{
  "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 // O número total de perfis de Registro de Emprego encontrados para o link
  }
}

Assim que você receber a notificação, poderá obter mais detalhes fazendo a seguinte solicitação:

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

Aguarde um webhook e obtenha dados de Emprego Atual

Assim que seu link de emprego (para o México) for criado, recuperamos assincronamente os Empregos Atuais para o link e enviamos o seguinte webhook:

No payload do webhook, incluímos o número de registros de Emprego Atual encontrados para o link.

{
  "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 // O número total de registros de Emprego Atual encontrados para o link
  }
}

Assim que você receber a notificação, poderá obter mais detalhes fazendo a seguinte solicitação:

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