Cadastro Técnico Federal
- Upload
- Buscar documento
- Modelo
Para efetuar o upload de um documento do tipo Cadastro Técnico Federal, basta enviar uma requisição POST conforme demonstrado abaixo. O seu código interno é o 11.
POST URL Ambiente/api_document/documents/upload
Header
| Identificador | Valor |
|---|---|
| Content-type | application/json |
| Accept | application/json |
| X-API-KEY | [api_key] |
Payload
| Parâmetro | Descrição | Obrigatório | Tipo | Exemplos |
|---|---|---|---|---|
| file | Conteúdo em base64 do documento | Sim | String | "iVBORw0KGgoAAAAN..." |
| fileType | Tipo do arquivo do documento enviado | Sim | String | "pdf" |
| type | Tipo do documento enviado | Sim | Integer | 11 |
| pages | Páginas a serem analisadas (Quando extensão for pdf) | Não | String | "1,2,5-10" |
Exemplo
{
"file": "iVBORw0KGgoAAAANSUhEUgAABHIAAAM+...",
"fileType": "pdf",
"type": 11,
"pages": "1,2,5-10"
}
Retorno
Status code 200
Ao enviar um documento, o retorno 200 dado pela api, irá enviar um objeto data nulo pois a inferência do documento ainda será feita. Para obter o resultado da Inteligência Artificial, é necessário utilizar a requisição vista na próxima sessão.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| id | Código interno do documento | UUID | "95893394-337c-429c-..." |
| status | Situação do documento (0-Received, 1-Finished, 2-Error, 3-In Progress) | Integer | 1 |
| statusDesc | Situação do documento (RECEIVED, FINISHED, IN_PROGRESS, 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",
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2022-10-14 14:38:50.045316",
"updatedAt": "2022-10-14 14:38:50.045316"
}
Para buscar o resultado do documento processado, disponibilizamos o método GET, mostrado a seguir. Pasta passar no parâmetro id, o UUID recebido no momento do upload.
GET URL Ambiente/api_document/documents/[id]
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 | 20.50 |
| 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" |
| finishedAt | Horário de finalização do processo | Datetime | "01/01/2023 00:00:00.0000" |
Exemplo
{
"id": "d53f9eba-0664-4e96-bb2b-e7f430333a98",
"status": 1,
"createdAt": "2024-04-06 10:42:03.752191-03:00",
"updatedAt": "2024-04-06 10:42:28.291350-03:00",
"statusDesc": "FINISHED",
"data": {
// Verificar em Modelo o resultado esperado desse documento
},
"processTime": null,
"finishedAt": "2024-04-06 10:42:28.285841-03:00"
}
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| placa | Placa | String | PIX1F000 |
| codDescricao | Descrição | Object | { '18-1': 'Transporte de cargas perigosas'} |
| dataValidade | Data de Validade | String | 01/02/2022 |