Começo rápido

A única coisa que você precisa para começar a usar a Palenca é uma conta de usuário e uma chave de API. Você pode obte-los aqui.

info

Temos 2 ambientes: Sandbox e produção. Para uma referência completa sobre todas as rotas de nossa API Click aqui.

https://sandbox.palenca.com/v1
https://api.palenca.com/v1

1. Obtenha sua API Key

Para poder fazer qualquer solicitação à API, você precisará identificá -lo usando sua API de chave privada. Isso deve ser enviado em cabeçalhos comox-api-key.

cURL

--header 'x-api-key: private_api_key' \
--header 'Content-Type: application/json'

JavaScript

    headers: {
        'x-api-key': 'private_api_key',
        'Content-Type': 'application/json'
    }

Python

headers = { 
   "x-api-key": "YOUR_PRIVATE_API_KEY",
   "Content-Type": "application/json"
   }

2. Crie sua primeira conexão

Neste passo criaremos um user (que representa um trabalhador) e uma account (que representa uma conexão com o IMSS) fazendo uma solicitação POST para o terminal /users /accounts. Esta solicitação deve incluir no payload o CURP do trabalhador (parâmetro identifier) e a plataforma onde estabeleceremos a conexão (neste caso IMSS). Não se esqueça de incluir a chave privada nos cabeçalhos.

cURL

curl --location --request POST 'https://sandbox.palenca.com/v1/users/accounts' \
--header 'x-api-key: YOUR_PRIVATE_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifier": "WORKER_CURP",
    "country": "mx",
    "platform": "imss"
    "widget_id": "YOUR_WIDGET_ID" // if empty, the default widget will be used
}'

JavaScript

const axios = require('axios');

const data = JSON.stringify({
    "identifier": "WORKER_CURP",  // Replace with the CURP you want to consult
    "country": "mx",
    "platform": "imss"
});

const config = {
    method: 'POST',
    url: 'https://sandbox.palenca.com/v1/users/accounts',
    headers: {
        'x-api-key': 'YOUR_PRIVATE_API_KEY',
        'Content-Type': 'application/json'
    },
    data: data
};

(async () => {
    try {
        const { data: responseData } = await axios(config);
        console.info(JSON.stringify(responseData));
    } catch (error) {
        console.error(error);
    }
})();
   

Python

   import requests
   import json
   
   headers = {  
    "Content-Type" : "application/json",  
    "x-api-key" : "YOUR_PRIVATE_API_KEY"
    }
   
   payload = {
    "identifier" : "WORKER_CURP", #aquí debe ir el CURP del cual quieres consultar la información
    "platform" : "imss",
   }
   
   response = requests.post("https://sandbox.palenca.com/v1/users/accounts", headers = headers,
                    params=json.dumps(payload))
   

Se tudo funcionou corretamente, você deve ver uma resposta como esta e o processo para obter os dados de emprego começou:

{
  "success": True,
  "error": None,
  "data": {
        "user_id": "054d0a9d-38ec-40cb-a31c-09b483242e4a",
        "country": "mx",
        "platform": "imss",
        "account_id": "472f02e8-6b24-43a7-b529-3f71d6ecc81c"
    }
}

3. Obtenha os dados de emprego

O processo de obtenção dos dados de emprego do trabalhador depende de cada plataforma (em média 10 segundos). Passado esse tempo, estamos prontos para recuperar o histórico profissional do trabalhador. Para fazer isso, precisamos fazer uma solicitação GET para /accounts/{account_id}/employment. Você poderá ver uma lista das empresas em que esse usuário já trabalhou, seus entes federativos e salários.

cURL

curl --location --request GET 'https://sandbox.palenca.com/v1/accounts/:account_id/employment' \
--header 'x-api-key: YOUR_PRIVATE_API_KEY' \
--header 'Content-Type: application/json'

JavaScript

const axios = require('axios');

const headers = {
    "Content-Type": "application/json",
    "x-api-key": "YOUR_PRIVATE_API_KEY"
}

const accountId = "account_id"; // Replace with the actual account_id from the previous step

const config = {
    method: 'GET',
    url: `https://sandbox.palenca.com/v1/accounts/${accountId}/employment`,
    headers: headers
};

(async () => {
    try {
        const { data } = await axios(config);
        console.info(JSON.stringify(data));
    } catch (error) {
        console.error(error);
    }
})();
   

Python

   import requests
   import json
   
   headers = {  
    "Content-Type" : "application/json",  
    "x-api-key" : "YOUR_PRIVATE_API_KEY"
    }  
    
    account_id = "account_id" #account_id del paso previo
    response = requests.get(f"https://sandbox.palenca.com/v1/accounts/{account_id}/employment", headers = headers)   

4. Integra um webhook

Para não depender do tempo de resposta da Palenca (~10 segundos) e ter que esperar que os dados de emprego estejam prontos, recomendamos a implementação de um Webhook que lhe permitirá receber uma notificação assim que os dados estiverem disponíveis para consulta.

rmações importantes

Consulte o guia para implementação de webhooks aqui. Se precisar de ajuda na sua implementação, clique aqui