Este artigo explica como enviar uma lista de nomes de pessoas físicas para enriquecimento por meio da API da Data Stone, utilizando o layout "Padrão - Pesquisa Por Nome PF" (ID 30), e como consultar o resultado depois de processado.
A documentação oficial completa está disponível em Data Stone API.
Base URL: https://api.datastone.com.br/v1
Autenticação: envie o header Authorization: SUA_API_KEY em todas as chamadas.
O enriquecimento acontece em três etapas:
Listar os layouts disponíveis, para confirmar o ID e os parâmetros do layout desejado.
Solicitar o enriquecimento, enviando o arquivo CSV com os nomes.
Consultar o resultado, usando o ID retornado na solicitação.
Utilize esta chamada para confirmar os IDs e os parâmetros de cada layout antes de solicitar o enriquecimento.
GET https://api.datastone.com.br/v1/enrichment/layouts/Headers:
Authorization: SUA_API_KEYPOST https://api.datastone.com.br/v1/enrichment/Headers:
Authorization: SUA_API_KEY
Content-Type: application/jsonBody (raw JSON):
{
"name": "Nome do enriquecimento",
"layout_id": 30,
"parameters": [],
"file": "UEsDBBQABgAIAAAAIQ...",
"callback_email": "[email protected]"
}Descrição dos campos:
name: nome que identifica o enriquecimento.
layout_id: ID do layout. Para "Padrão - Pesquisa Por Nome PF", utilize 30.
parameters: lista de parâmetros do layout. Neste layout, envie a lista vazia.
file: arquivo CSV codificado em base64, com uma coluna chamada NOME.
callback_email: e-mail que será avisado quando o enriquecimento for concluído.
O arquivo CSV deve conter uma coluna NOME, com um nome por linha.
Resposta esperada:
{
"id": 98765,
"status": "requested"
}Guarde o valor de id, pois ele é utilizado na etapa seguinte para consultar o resultado.
GET https://api.datastone.com.br/v1/enrichment/{id}/result/Headers:
Authorization: SUA_API_KEYSubstitua {id} pelo valor retornado na etapa 2.
Resposta quando o resultado estiver pronto:
{
"file": "https://storage.datastone.com.br/enrichment/results/98765-resultado.csv?token=...&expires=...",
"metrics": {
"Documentos enviados": 1,
"Documentos enriquecidos": 1
}
}Descrição dos campos:
file: URL temporária do CSV com o resultado do enriquecimento. Como o link expira, faça o download assim que receber a resposta.
metrics: resumo do processamento, como a quantidade de documentos enviados e de documentos enriquecidos.