Buscar um documento
O Idexa disponibiliza duas maneiras de se obter o resultado do processamento. A primeira é um metódo padrão de GET, onde é necessário o envio de seu ID recebido no momento do upload.
A segunda maneira é via Webhook. Não se preocupe, enviaremos o resultado para você. Mostraremos na próxima etapa como efetuar a configuração.
Serviço de documentos - Retornar documento
GET URL Ambiente/api_document/documents/[id]
O método /api_document/documents/[id] recebe os seguintes parâmetros, onde [id] é o código UUID do documento.
Header
| Identificador | Valor |
|---|---|
| Content-type | application/json |
| Accept | application/json |
| X-API-KEY | [api_key] |
Retorno
Status code 200
Um http code 200 é retornado quando o documento é inserido corretamente.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| id | Código interno do documento | UUID | "95893394-337c-429c-..." |
| data | Objeto retornado pela IA | Modelo referente ao tipo do documento | json_object |
| processTime | Tempo de processamento | Float | 10.02232 |
| status | Situação do documento (0-Received, 1-Finished, 2-Error) | Integer | 3 |
| statusDesc | Situação do documento (RECEIVED, FINISHED, ERROR) | String | "FINISHED" |
| createdAt | Horário de criação do registro | Datetime | "01/01/2023 00:00:00.0000" |
| updatedAt | Horário de atualização do registro | Datetime | "01/01/2023 00:00:00.0000" |
Exemplo
{
"id": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
"data": {
// Verificar em Modelo o resultado esperado desse documento
},
"processTime": null,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2022-10-14 14:38:50.045316",
"updatedAt": "2022-10-14 14:38:50.045316"
}