Resultados de Amostra Laboratorial
Modelo na Plataforma
Sigla: AMOSTRA LAB
Descrição: Resultados de Amostra Laboratorial
Modelo Via API
Type: 29
Este modelo extrai informações-chave de um Resultados de Amostra Laboratorial (AMOSTRA LAB).
O processo de extração é assíncrono e consiste em dois passos principais:
- Enviar o documento para a fila de processamento.
- Consultar o resultado após a conclusão do processamento.
Passo 1: Enviar o Documento para Processamento
Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.
POST URL Ambiente/documents/upload
Headers
| Identificador | Valor |
|---|---|
Content-Type | multipart/form-data |
IDEXA-API-KEY | sua_api_key |
Payload (Corpo da Requisição)
A requisição deve conter os seguintes parâmetros obrigatórios:
| Parâmetro | Descriçao | Tipo |
|---|---|---|
files | O arquivo do documento a ser processado. | File |
type | Código interno do modelo. Use 29 para RESULTADOS_AMOSTRA. | Integer |
Os parâmetros a seguir são opcionais:
| Parâmetro | Descriçao | Tipo |
|---|---|---|
pages | Define páginas específicas para análise (ex: "1,2,5-10"). | String |
externalId | Id externo para seu controle (não pode repetir). | String |
Exemplos de Requisição
- cURL
- JavaScript
- Python
- PHP
curl -X POST "URL_BASE/documents/upload" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/seu/documento.pdf" \
-F "type=29" \
-F "externalId=pedido-cliente-123"
const myHeaders = new Headers();
myHeaders.append("IDEXA-API-KEY", "sua_api_key");
const formdata = new FormData();
formdata.append("files", fileInput.files[0], "documento.pdf");
formdata.append("type", "29");
formdata.append("externalId", "pedido-cliente-123");
const requestOptions = { method: 'POST', headers: myHeaders, body: formdata };
fetch("URL_BASE/documents/upload", requestOptions)
.then(response => response.json())
.then(result => console.log(result));
import requests
url = "URL_BASE/documents/upload"
payload = {'type': '29', 'externalId': 'pedido-123'}
files=[('files',('documento.pdf',open('/path/to/documento.pdf','rb'),'application/pdf'))]
headers = {'IDEXA-API-KEY': 'sua_api_key'}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "URL_BASE/documents/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'files' => new CURLFile('/path/to/documento.pdf'),
'type' => '29',
'externalId' => 'pedido-cliente-123'
],
CURLOPT_HTTPHEADER => [
"IDEXA-API-KEY: sua_api_key"
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Resposta Imediata (Status 200)
A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 29,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.
Passo 2: Consultar o Resultado
Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.
GET URL Ambiente/documents/[id]
Resposta Final (Status 200)
Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 29,
"data": {
"ano": "2024",
"mes": "03/2024",
"data_coleta": "19/02/2024",
"numero_boletim": "62932/2024-0",
"nome_amostra": "ETE – Junção das Estações",
"numero_processo": "12001/2022",
"parametros": [
{
"ss": "0.00",
"1112_tetracloroetano": "0.00",
"111_tricloroetano": "0.00",
"1122_tetracloroetano": "0.00",
"112_triclooetano": "0.00",
"11_dicloroetano": "0.00",
"11_dicloroeteno": "0.00",
"11_dicloropopeno": "0.00",
"123_triclorobenzeno": "0.00",
"123_tricloropropano": "0.00",
"124_triclorobenzeno": "0.00",
"124_trimetilbenzeno": "0.00",
"12_dibromo3_cloropropano": "0.00",
"12_dibromoetano": "0.00",
"12_diclorobenzeno": "0.00",
"12_dicloroetano": "0.00",
"12_dicloroeteno": "0.00",
"12_dicloropropano": "0.00",
"135_triclorobenzeno": "0.00",
"135_trimetilbenzeno": "0.00",
"13_diclorobenzeno": "0.00",
"13_dicloropropano": "0.00",
"14_diclorobenzeno": "0.00",
"22_dicloropropano": "0.00",
"2_clorotolueno": "0.00",
"4_clorotolueno": "0.00",
"4_metil2_pentanona": "0.00",
"acenafteno": "0.00",
"acenaftileno": "0.00",
"aluminio": "0.00",
"amonia_n_h3": "0.00",
"amonia_ionizavel": "0.00",
"antraceno": "0.00",
"arsenio": "0.00",
"benzeno": "0.00",
"benzo_a_antraceno": "0.00",
"benzo_a_pireno": "0.00",
"benzo_b_fluoranteno": "0.00",
"benzo_g_h_i_perileno": "0.00",
"benzo_k_fluoranteno": "0.00",
"bromobenzeno": "0.00",
"bromoclorometano": "0.00",
"bromodiclorometano": "0.00",
"bomoformio": "0.00",
"bromometano": "0.00",
"cadmio": "0.00",
"carbono_organico_total": "0.00",
"chumbo": "0.00",
"cianeto": "0.00",
"cis12_dicloroeteno": "0.00",
"cis13_dicloropopeno": "0.00",
"cloreto_vinila": "0.00",
"clorobenzeno": "0.00",
"cloroetano": "0.00",
"cloroformio": "0.00",
"clorometano": "0.00",
"cobre_dissolvido": "0.00",
"coliforme_termotolerante": "0.00",
"criseno": "0.00",
"cromo_hexavalente": "0.00",
"cromo_total": "0.00",
"cromo_trivalente": "0.00",
"dbo": "0.00",
"dibenzo_a_h_antraceno": "0.00",
"dibromoclorometano": "0.00",
"dibromometano": "0.00",
"diclorometano": "0.00",
"dissulfeto_carbono": "0.00",
"dqo": "0.00",
"estanho": "0.00",
"estireno": "0.00",
"etilbenzeno": "0.00",
"fenantreno": "0.00",
"fenois_totais": "0.00",
"ferro_dissolvido": "0.00",
"fluoranteno": "0.00",
"fluoreno": "0.00",
"fluoreto": "0.00",
"fosforo": "0.00",
"hexaclorobutadieno": "0.00",
"indeno123_cd_pireno": "0.00",
"isopropilbenzeno": "0.00",
"m_p_xilenos": "0.00",
"manganes_dissolvido": "0.00",
"mercurio": "0.00",
"naftaleno": "0.00",
"n_butilbenzeno": "0.00",
"niquel": "0.00",
"nitrato_n": "0.00",
"nitrito_n": "0.00",
"nitogenio_amoniacal": "0.00",
"nitrogenio_organico": "0.00",
"nitogenio_total": "0.00",
"nitrogenio_total_kjeldahl": "0.00",
"n_propilbenzeno": "0.00",
"oleo_graxas_minerais": "0.00",
"oleos_graxas_totais": "0.00",
"oleos_graxas_vegetais_animais": "0.00",
"oxigenio_dissolvido": "0.00",
"o_xileno": "0.00",
"p_h": "0.00",
"pireno": "0.00",
"p_isopropiltolueno": "0.00",
"salinidade": "0.00",
"sec_butilbenzeno": "0.00",
"solidos_dissolvidos_totais": "0.00",
"solidos_sedimentaveis": "0.00",
"solidos_suspensos_totais": "0.00",
"solidos_totais": "0.00",
"sulfato": "0.00",
"sulfeto": "0.00",
"surfactantes": "0.00",
"temperatura": "0.00",
"terc_butilbenzeno": "0.00",
"tetracloreto_carbono": "0.00",
"tetracloroeteno": "0.00",
"toc": "0.00",
"tolueno": "0.00",
"total_p_a_h": "0.00",
"toxicidade_aguda": "0.00",
"toxicidade_dubia": "0.00",
"trans12_dicloroeteno": "0.00",
"trans13_dicloropropeno": "0.00",
"triclorobenzenos": "0.00",
"tricloroeteno": "0.00",
"vazao": "0.00",
"xilenos": "0.00",
"zinco": "0.00"
}
]
},
"processTime": 8.123,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:58.168Z"
}
Dicionário de Dados: Resultados de Amostra Laboratorial
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| ano | String | Ano | "2024" |
| mes | String | Mês | "03/2024" |
| dataColeta | String | Dada da coleta | "19/02/2024" |
| numeroBoletim | String | Número do boletim | "62932/2024-0" |
| nomeAmostra | String | Nome da amostra | "ETE – Junção das Estações" |
| numeroProcesso | String | Numero do processo | "12001/2022" |
| parametros[].ss | String | Ss | "0.00" |
| parametros[].1112Tetracloroetano | String | 1112 Tetracloroetano | "0.00" |
| parametros[].111Tricloroetano | String | 111 Tricloroetano | "0.00" |
| parametros[].1122Tetracloroetano | String | 1122 Tetracloroetano | "0.00" |
| parametros[].112Triclooetano | String | 112 Triclooetano | "0.00" |
| parametros[].11Dicloroetano | String | 11 Dicloroetano | "0.00" |
| parametros[].11Dicloroeteno | String | 11 Dicloroeteno | "0.00" |
| parametros[].11Dicloropopeno | String | 11 Dicloropopeno | "0.00" |
| parametros[].123Triclorobenzeno | String | 123 Triclorobenzeno | "0.00" |
| parametros[].123Tricloropropano | String | 123 Tricloropropano | "0.00" |
| parametros[].124Triclorobenzeno | String | 124 Triclorobenzeno | "0.00" |
| parametros[].124Trimetilbenzeno | String | 124 Trimetilbenzeno | "0.00" |
| parametros[].12Dibromo3Cloropropano | String | 12 Dibromo3 Cloropropano | "0.00" |
| parametros[].12Dibromoetano | String | 12 Dibromoetano | "0.00" |
| parametros[].12Diclorobenzeno | String | 12 Diclorobenzeno | "0.00" |
| parametros[].12Dicloroetano | String | 12 Dicloroetano | "0.00" |
| parametros[].12Dicloroeteno | String | 12 Dicloroeteno | "0.00" |
| parametros[].12Dicloropropano | String | 12 Dicloropropano | "0.00" |
| parametros[].135Triclorobenzeno | String | 135 Triclorobenzeno | "0.00" |
| parametros[].135Trimetilbenzeno | String | 135 Trimetilbenzeno | "0.00" |
| parametros[].13Diclorobenzeno | String | 13 Diclorobenzeno | "0.00" |
| parametros[].13Dicloropropano | String | 13 Dicloropropano | "0.00" |
| parametros[].14Diclorobenzeno | String | 14 Diclorobenzeno | "0.00" |
| parametros[].22Dicloropropano | String | 22 Dicloropropano | "0.00" |
| parametros[].2Clorotolueno | String | 2 Clorotolueno | "0.00" |
| parametros[].4Clorotolueno | String | 4 Clorotolueno | "0.00" |
| parametros[].4Metil2Pentanona | String | 4 Metil2 Pentanona | "0.00" |
| parametros[].acenafteno | String | Acenafteno | "0.00" |
| parametros[].acenaftileno | String | Acenaftileno | "0.00" |
| parametros[].aluminio | String | Aluminio | "0.00" |
| parametros[].amoniaNH3 | String | Amonia N H3 | "0.00" |
| parametros[].amoniaIonizavel | String | Amonia Ionizavel | "0.00" |
| parametros[].antraceno | String | Antraceno | "0.00" |
| parametros[].arsenio | String | Arsenio | "0.00" |
| parametros[].benzeno | String | Benzeno | "0.00" |
| parametros[].benzoAAntraceno | String | Benzo A Antraceno | "0.00" |
| parametros[].benzoAPireno | String | Benzo A Pireno | "0.00" |
| parametros[].benzoBFluoranteno | String | Benzo B Fluoranteno | "0.00" |
| parametros[].benzoGHIPerileno | String | Benzo G H I Perileno | "0.00" |
| parametros[].benzoKFluoranteno | String | Benzo K Fluoranteno | "0.00" |
| parametros[].bromobenzeno | String | Bromobenzeno | "0.00" |
| parametros[].bromoclorometano | String | Bromoclorometano | "0.00" |
| parametros[].bromodiclorometano | String | Bromodiclorometano | "0.00" |
| parametros[].bomoformio | String | Bomoformio | "0.00" |
| parametros[].bromometano | String | Bromometano | "0.00" |
| parametros[].cadmio | String | Cadmio | "0.00" |
| parametros[].carbonoOrganicoTotal | String | Carbono Organico Total | "0.00" |
| parametros[].chumbo | String | Chumbo | "0.00" |
| parametros[].cianeto | String | Cianeto | "0.00" |
| parametros[].cis12Dicloroeteno | String | Cis12 Dicloroeteno | "0.00" |
| parametros[].cis13Dicloropopeno | String | Cis13 Dicloropopeno | "0.00" |
| parametros[].cloretoVinila | String | Cloreto Vinila | "0.00" |
| parametros[].clorobenzeno | String | Clorobenzeno | "0.00" |
| parametros[].cloroetano | String | Cloroetano | "0.00" |
| parametros[].cloroformio | String | Cloroformio | "0.00" |
| parametros[].clorometano | String | Clorometano | "0.00" |
| parametros[].cobreDissolvido | String | Cobre Dissolvido | "0.00" |
| parametros[].coliformeTermotolerante | String | Coliforme Termotolerante | "0.00" |
| parametros[].criseno | String | Criseno | "0.00" |
| parametros[].cromoHexavalente | String | Cromo Hexavalente | "0.00" |
| parametros[].cromoTotal | String | Cromo Total | "0.00" |
| parametros[].cromoTrivalente | String | Cromo Trivalente | "0.00" |
| parametros[].dbo | String | Dbo | "0.00" |
| parametros[].dibenzoAHAntraceno | String | Dibenzo A H Antraceno | "0.00" |
| parametros[].dibromoclorometano | String | Dibromoclorometano | "0.00" |
| parametros[].dibromometano | String | Dibromometano | "0.00" |
| parametros[].diclorometano | String | Diclorometano | "0.00" |
| parametros[].dissulfetoCarbono | String | Dissulfeto Carbono | "0.00" |
| parametros[].dqo | String | Dqo | "0.00" |
| parametros[].estanho | String | Estanho | "0.00" |
| parametros[].estireno | String | Estireno | "0.00" |
| parametros[].etilbenzeno | String | Etilbenzeno | "0.00" |
| parametros[].fenantreno | String | Fenantreno | "0.00" |
| parametros[].fenoisTotais | String | Fenois Totais | "0.00" |
| parametros[].ferroDissolvido | String | Ferro Dissolvido | "0.00" |
| parametros[].fluoranteno | String | Fluoranteno | "0.00" |
| parametros[].fluoreno | String | Fluoreno | "0.00" |
| parametros[].fluoreto | String | Fluoreto | "0.00" |
| parametros[].fosforo | String | Fosforo | "0.00" |
| parametros[].hexaclorobutadieno | String | Hexaclorobutadieno | "0.00" |
| parametros[].indeno123CdPireno | String | Indeno123 Cd Pireno | "0.00" |
| parametros[].isopropilbenzeno | String | Isopropilbenzeno | "0.00" |
| parametros[].mPXilenos | String | M P Xilenos | "0.00" |
| parametros[].manganesDissolvido | String | Manganes Dissolvido | "0.00" |
| parametros[].mercurio | String | Mercurio | "0.00" |
| parametros[].naftaleno | String | Naftaleno | "0.00" |
| parametros[].nButilbenzeno | String | N Butilbenzeno | "0.00" |
| parametros[].niquel | String | Niquel | "0.00" |
| parametros[].nitratoN | String | Nitrato N | "0.00" |
| parametros[].nitritoN | String | Nitrito N | "0.00" |
| parametros[].nitogenioAmoniacal | String | Nitogenio Amoniacal | "0.00" |
| parametros[].nitrogenioOrganico | String | Nitrogenio Organico | "0.00" |
| parametros[].nitogenioTotal | String | Nitogenio Total | "0.00" |
| parametros[].nitrogenioTotalKjeldahl | String | Nitrogenio Total Kjeldahl | "0.00" |
| parametros[].nPropilbenzeno | String | N Propilbenzeno | "0.00" |
| parametros[].oleoGraxasMinerais | String | Oleo Graxas Minerais | "0.00" |
| parametros[].oleosGraxasTotais | String | Oleos Graxas Totais | "0.00" |
| parametros[].oleosGraxasVegetaisAnimais | String | Oleos Graxas Vegetais Animais | "0.00" |
| parametros[].oxigenioDissolvido | String | Oxigenio Dissolvido | "0.00" |
| parametros[].oXileno | String | O Xileno | "0.00" |
| parametros[].pH | String | P H | "0.00" |
| parametros[].pireno | String | Pireno | "0.00" |
| parametros[].pIsopropiltolueno | String | P Isopropiltolueno | "0.00" |
| parametros[].salinidade | String | Salinidade | "0.00" |
| parametros[].secButilbenzeno | String | Sec Butilbenzeno | "0.00" |
| parametros[].solidosDissolvidosTotais | String | Solidos Dissolvidos Totais | "0.00" |
| parametros[].solidosSedimentaveis | String | Solidos Sedimentaveis | "0.00" |
| parametros[].solidosSuspensosTotais | String | Solidos Suspensos Totais | "0.00" |
| parametros[].solidosTotais | String | Solidos Totais | "0.00" |
| parametros[].sulfato | String | Sulfato | "0.00" |
| parametros[].sulfeto | String | Sulfeto | "0.00" |
| parametros[].surfactantes | String | Surfactantes | "0.00" |
| parametros[].temperatura | String | Temperatura | "0.00" |
| parametros[].tercButilbenzeno | String | Terc Butilbenzeno | "0.00" |
| parametros[].tetracloretoCarbono | String | Tetracloreto Carbono | "0.00" |
| parametros[].tetracloroeteno | String | Tetracloroeteno | "0.00" |
| parametros[].toc | String | Toc | "0.00" |
| parametros[].tolueno | String | Tolueno | "0.00" |
| parametros[].totalPAH | String | Total P A H | "0.00" |
| parametros[].toxicidadeAguda | String | Toxicidade Aguda | "0.00" |
| parametros[].toxicidadeDubia | String | Toxicidade Dubia | "0.00" |
| parametros[].trans12Dicloroeteno | String | Trans12 Dicloroeteno | "0.00" |
| parametros[].trans13Dicloropropeno | String | Trans13 Dicloropropeno | "0.00" |
| parametros[].triclorobenzenos | String | Triclorobenzenos | "0.00" |
| parametros[].tricloroeteno | String | Tricloroeteno | "0.00" |
| parametros[].vazao | String | Vazao | "0.00" |
| parametros[].xilenos | String | Xilenos | "0.00" |
| parametros[].zinco | String | Zinco | "0.00" |