Minuta de Despacho Eletrônica
Modelo na Plataforma
Sigla: MIN DESP
Descrição: Minuta de Despacho Eletrônica
Modelo Via API
Type: 30
Este modelo extrai informações-chave de um Minuta de Despacho Eletrônica (MIN DESP).
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 30 para MINUTA. | 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=30" \
-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", "30");
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': '30', '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' => '30',
'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": 30,
"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": 30,
"data": {
"freight": {
"taker": "FULANO DA SILVA",
"id_number": "xx.xxx.xxx/xxxx-xx",
"gollog_number": "00000000000"
},
"description": {
"payment": "CARTÃO",
"service": "URGENTE",
"origin_airport": "BSB",
"pick_up_airport": "BSB",
"tipe_of_delivery": "RETIRADA"
},
"product_data": {
"receipt": "xxxxx-xxxx",
"volume_n": "xx",
"main_product": "PRODUTO",
"total_weight": "xx",
"dangerous_product": "SIM"
},
"senders_data": {
"city": "Uberaba",
"email": "xxxxxxx@xxxx.xx",
"sender": "FULANO DA SILVA",
"address": "Rua A",
"id_number": "xxx.xxx.xxx-xx",
"phone_number": "(xx)xxxxxxxxx"
},
"internal_data": {
"issued_by": "FULANO DA SILVA",
"air_waybill": "xxxxxxxxxxx",
"receipt_date": "xx/xx/xxxx"
},
"insurance_data": {
"policy_n": "xxxxxxxxxxx",
"insurance_type": "PROPRIO",
"insurance_company": "XXX SECURITY"
},
"receivers_data": {
"city": "Uberaba",
"address": "Rua A",
"receiver": "FULANO DA SILVA",
"id_number": "xxx.xxx.xxx-xx"
},
"authorization_data": {
"place_date": "xx/xx/xxxx",
"accountable": "FULANO DA SILVA",
"boarding_authorization": "SIM"
}
},
"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: Minuta de Despacho Eletrônica
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| freight.taker | String | taker | "FULANO DA SILVA" |
| freight.idNumber | String | id_number | "xx.xxx.xxx/xxxx-xx" |
| freight.gollogNumber | String | gollog_number | "00000000000" |
| description.payment | String | payment | "CARTÃO" |
| description.service | String | service | "URGENTE" |
| description.originAirport | String | origin_airport | "BSB" |
| description.pickUpAirport | String | pick_up_airport | "BSB" |
| description.tipeOfDelivery | String | tipe_of_delivery | "RETIRADA" |
| productData.receipt | String | receipt | "xxxxx-xxxx" |
| productData.volumeN | String | volume_n | "xx" |
| productData.mainProduct | String | main_product | "PRODUTO" |
| productData.totalWeight | String | total_weight | "xx" |
| productData.dangerousProduct | String | dangerous_product | "SIM" |
| sendersData.city | String | city | "Uberaba" |
| sendersData.email | String | "xxxxxxx@xxxx.xx" | |
| sendersData.sender | String | sender | "FULANO DA SILVA" |
| sendersData.address | String | address | "Rua A" |
| sendersData.idNumber | String | id_number | "xxx.xxx.xxx-xx" |
| sendersData.phoneNumber | String | phone_number | "(xx)xxxxxxxxx" |
| internalData.issuedBy | String | issued_by | "FULANO DA SILVA" |
| internalData.airWaybill | String | air_waybill | "xxxxxxxxxxx" |
| internalData.receiptDate | String | receipt_date | "xx/xx/xxxx" |
| insuranceData.policyN | String | policy_n | "xxxxxxxxxxx" |
| insuranceData.insuranceType | String | insurance_type | "PROPRIO" |
| insuranceData.insuranceCompany | String | insurance_company | "XXX SECURITY" |
| receiversData.city | String | city | "Uberaba" |
| receiversData.address | String | address | "Rua A" |
| receiversData.receiver | String | receiver | "FULANO DA SILVA" |
| receiversData.idNumber | String | id_number | "xxx.xxx.xxx-xx" |
| authorizationData.placeDate | String | place_date | "xx/xx/xxxx" |
| authorizationData.accountable | String | accountable | "FULANO DA SILVA" |
| authorizationData.boardingAuthorization | String | boarding_authorization | "SIM" |