Guia de Integração

Visão Geral da Jornada

Antes de iniciar qualquer integração técnica, é importante entender o caminho completo. As 8 fases abaixo representam a sequência típica de um onboarding bem-sucedido na Autovist.

flowchart LR F1["📋 Fase 1\nAlinhamento"] --> F2["🖥️ Fase 2\nPlataforma"] F2 --> F3["⚙️ Fase 3\nStaging"] F3 --> F4["🔌 Fase 4\nAPI"] F4 --> F5["🧪 Fase 5\nTestes"] F5 --> F6["📡 Fase 6\nWebhooks"] F6 --> F7["📄 Fase 7\nLaudo"] F7 --> F8["🚀 Fase 8\nGo-Live"] style F1 fill:#eff6ff,stroke:#3b82f6,color:#1d4ed8 style F2 fill:#f5f3ff,stroke:#7c3aed,color:#5b21b6 style F3 fill:#fffbeb,stroke:#d97706,color:#92400e style F4 fill:#ecfdf5,stroke:#059669,color:#065f46 style F5 fill:#ecfeff,stroke:#0891b2,color:#164e63 style F6 fill:#fdf2f8,stroke:#db2777,color:#9d174d style F7 fill:#fff7ed,stroke:#ea580c,color:#9a3412 style F8 fill:#f0fdf4,stroke:#16a34a,color:#14532d

✅ Checklist Mestre de Onboarding

Marque os itens conforme cada etapa for concluída.

Fase 1: Reunião de alinhamento realizada — empresa e produto cadastrados pelo time Autovist.
Fase 2: Acesso à plataforma obtido — primeiro ciclo completo de vistoria realizado manualmente.
Fase 3: IDs de staging recebidos (company_id, flow_id, credenciais de integração).
Fase 4: Autenticação, criação de vistoria e cancelamento implementados e funcionando.
Fase 5: Todos os cenários de teste executados com sucesso no ambiente de staging.
Fase 6: Endpoint de webhook configurado — recepção validada para status intermediários e finais.
Fase 7: Download do laudo em PDF testado com sucesso.
Fase 8: Go-live planejado — IDs de produção recebidos — subida realizada com sucesso.

💡

Todas as dúvidas durante o processo de integração devem ser direcionadas a suporte@autovist.com.br. O time de suporte é o ponto central de contato para configurações de empresa, produto, APIs externas e IAs.

Fase 1

Alinhamento Inicial

Antes de qualquer acesso técnico, o time Autovist conduz uma reunião de onboarding para entender o contexto do cliente e configurar empresa e produto na plataforma. Toda configuração é realizada internamente pelo time de suporte e sucesso do cliente.

📬

Ponto central de contato — Suporte & Sucesso do Cliente

suporte@autovist.com.br

📝 O que o cliente fornece

Informação	Descrição
Razão Social / Nome Fantasia	Identificação da empresa
CNPJ	Para cadastro legal
Usuários do sistema	Nome, e-mail e perfil de cada usuário
Definição do produto	Tipo de vistoria, campos do formulário, regras de negócio
URL de webhook	Endpoint HTTPS para receber notificações de mudança de status (transições e finalizações)
APIs externas desejadas	Consultas adicionais a ativar (ex: score, histórico)

⚙️ O que o time Autovist configura

Entregável	Descrição
`company_id`	UUID da empresa cadastrada
`flow_id`	ID do produto/fluxo configurado
Credenciais de acesso	E-mail e senha do usuário de integração
Configuração de IA	Análise automática ativada se contratada
APIs externas	Ativadas conforme regras de negócio acordadas
Período de validade	Tempo de expiração das vistorias no produto

🔗 Sobre APIs Externas e Inteligências Artificiais

A plataforma Autovist suporta integração com serviços externos (consultas a tabelas de mercado, bureaus e dados de veículo) e ferramentas de IA para análise automática de danos e scoring de risco. Todas as ativações são realizadas pelo time de suporte na configuração do produto, com base nas regras de negócio acordadas.

A utilização mais comum de APIs externas ocorre durante a tela de análise de risco, onde o sistema realiza consultas automáticas ao atingir determinados status da vistoria. Os resultados são retornados no campo apis[] do payload do webhook.

⚠️

O cliente não tem acesso direto ao painel de configuração de empresa e produto. Qualquer alteração deve ser solicitada ao time de suporte via suporte@autovist.com.br.

Fase 2

Plataforma — Primeiro Contato

Antes de integrar via API, é fundamental que o time técnico compreenda o fluxo completo navegando pela plataforma web. Esta etapa proporciona uma visão prática de ponta a ponta — da criação da vistoria ao laudo final.

flowchart TD A["🔑 Login na Plataforma"] --> B["➕ Criar Nova Vistoria"] B --> C["📝 Preencher Formulário do Produto"] C --> D["🔗 Copiar Link da Vistoria"] D --> E["📱 Acessar Webapp da Vistoria"] E --> F["📸 Enviar Fotos e Documentos no Webapp"] F --> G["❓ Responder Questionário"] G --> H["🔍 Tela de Análise de Risco"] H --> I["🔧 Registrar Danos e Custos"] I --> J["💰 Calcular Valor de Mercado"] J --> K["📋 Completar Checklist de Análise"] K --> M["📄 Emitir Laudo Final"] M --> N{"Decisão"} N -->|Aprovado| O["✅ APROVADO"] N -->|Reprovado| P["❌ REPROVADO"] N -->|Inconclusivo| Q["⏳ SUJEITO À ANÁLISE"] style P fill:#f0fdf4,stroke:#16a34a,color:#14532d style Q fill:#fef2f2,stroke:#dc2626,color:#991b1b

1

Login na Plataforma

Acesse o link da plataforma fornecido pelo time Autovist e realize o login com as credenciais do seu usuário. Após 3 tentativas incorretas consecutivas de senha, a conta é bloqueada automaticamente e requer desbloqueio pelo administrador.

Tela de Login — Tela de login da plataforma Autovist

2

Criar Nova Vistoria

Na plataforma, localize a opção de criar uma nova vistoria. Preencha o formulário do produto configurado pelo time Autovist — os campos variam conforme o fluxo contratado. Campos obrigatórios são destacados na interface.

Criar Vistoria — Formulário de criação de vistoria na plataforma

3

Obter o Link da Vistoria

Após criar a vistoria, a plataforma gera automaticamente um link único de acesso ao webapp de vistoria. Copie esse link — ele deve ser enviado ao vistoriador para que fotos e documentos sejam submetidos.

4

Realizar a Vistoria no Webapp

Acesse o link em um dispositivo móvel. O webapp guiará o usuário por cada solicitação: fotos nos ângulos definidos, documentos (CNH, CRLV, CPF, RG), assinatura digital e questionários. Toda captura inclui dados de geolocalização automáticos.

Webapp de Vistoria — Webapp mobile de realização da vistoria

💡

Após o envio de todas as solicitações, o status avança automaticamente. Acompanhe a progressão em tempo real pela plataforma.

5

Acessar a Tela de Análise de Risco

Volte à plataforma e acesse a tela de análise de risco da vistoria. Esta é a central onde o analista visualiza todas as fotos, documentos, respostas e dados do veículo. APIs externas contratadas são consultadas automaticamente nesta etapa.

6

Registrar Danos e Calcular Valor de Mercado

O analista identifica os danos visíveis, registrando componente afetado, tipo de dano, ação de reparo, custo estimado e tempo de mão de obra por especialidade (mecânica, pintura, funilaria, elétrica, estofamento). O valor de mercado é calculado com base na tabela FIPE ou valor manual, com percentual configurado no produto.

Danos e Valor de Mercado — Registro de danos, reparos e cálculo de valor de mercado

7

Completar o Checklist de Análise

Cada produto possui um checklist de itens de análise configurado pelo time Autovist. O analista avalia cada item com base nas evidências, atribuindo resultado (Aprovado, Reprovado ou outros) e podendo adicionar observações internas ou externas com anexos de evidência. Ao concluir os itens de análise, o analista deve clicar em Finalizar no fim da página.

8

Gerar o Laudo e a Decisão Final

Concluída a análise, o analista emite o laudo com a decisão final. O sistema gera automaticamente um PDF completo com todos os dados da vistoria e dispara o webhook para o sistema integrado.

Laudo Final — Laudo final com decisão da análise de risco

✅ Aprovado — bem dentro dos critérios de risco ❌ Reprovado — critérios de risco não atendidos ⏳ Sujeito à Análise — requer revisão de gestão

Fase 3

Ambiente de Staging

Antes de iniciar a integração técnica, aguarde o time Autovist disponibilizar os identificadores e credenciais do ambiente de staging (homologação / UAT). Não inicie a integração sem esses dados em mãos.

📦 IDs e credenciais que você receberá

Item	Tipo	Onde usar
`company_id`	UUID	Obrigatório em todas as chamadas de criação de vistoria
`flow_id`	ID	Obrigatório na criação — define o produto/fluxo
E-mail do usuário de integração	String	Login na API de autenticação
Senha do usuário de integração	String	Login na API de autenticação
URL de acesso à plataforma (staging)	URL	Acompanhamento manual das vistorias de teste

🧪 Staging / UAT

https://staging-authentication.autovist.com.br

https://staging-process.autovist.com.br

Ambiente para desenvolvimento e testes. Dados não afetam produção.

🚀 Produção

https://authentication.autovist.com.br

https://process.autovist.com.br

IDs e credenciais diferentes do staging. Ativar somente após go-live aprovado.

✅ Pré-requisitos técnicos antes de integrar

Serviço capaz de realizar requisições HTTP POST com corpo JSON
Endpoint HTTPS disponível para receber o payload do webhook
Capacidade de armazenar e renovar tokens JWT automaticamente
Suporte a download de arquivo binário PDF via HTTP
Capacidade de parsear JSON aninhado com múltiplos arrays
company_id, flow_id e credenciais de staging recebidos do time Autovist

Fase 4

Integração via API

A API REST da Autovist expõe endpoints para criação, cancelamento de vistorias e download do laudo em PDF. Toda comunicação utiliza JSON e autenticação via token JWT.

4.1 Autenticação

Todas as chamadas protegidas exigem um access token JWT no header Authorization: Bearer {token}. Validade de 1 hora. Use o refresh token (validade de 1 dia) para renovar sem refazer o login.

POST https://staging-authentication.autovist.com.br/api/v1/users/token/

Realiza o login e retorna o par de tokens JWT (access + refresh).

Request Body

{
  "email": "usuario@empresa.com.br",
  "password": "sua_senha"
}

Response 200

{
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "d21a529b-3549-4a35-b16b-c2e39c70147e",
    "name": "Nome do Usuário",
    "email": "usuario@empresa.com.br",
    "is_active": true
  }
}

POST https://staging-authentication.autovist.com.br/api/v1/users/token/refresh/

Renova o access token usando o refresh token. Utilize antes da expiração de 1 hora.

Request Body

{
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response 200

{
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "d21a529b-3549-4a35-b16b-c2e39c70147e",
    "name": "Nome do Usuário",
    "email": "usuario@empresa.com.br",
    "is_active": true
  }
}

⚠️

Após 3 tentativas de login com senha incorreta, a conta é bloqueada. O desbloqueio deve ser solicitado ao time Autovist via suporte.

4.2 Criar Vistoria

Endpoint principal da integração. Cria uma nova vistoria e retorna o objeto completo com ID e status inicial. Requer permissão manage_processes ou perfil administrador.

POST https://staging-process.autovist.com.br/api/v1/inspections/create/

Cria uma nova vistoria. O status inicial retornado será WAITING_SOLICITATIONS.

Headers obrigatórios

{
  "Content-Type": "application/json",
  "Authorization": "Bearer {seu_access_token}"
}

Request Body

{
  "company_id": "d21a529b-3549-4a35-b16b-c2e39c70147e",
  "flow_id": "68c30f8c6ed291b15d825463",
  "identifier": "PROP-2026-001",
  "process_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
  "proposal_id": "c4b3a2f1-e0d9-8765-4321-fedcba987654",
  "form": [
    { "code": "nome_do_cliente", "value": "João da Silva" },
    { "code": "cpf", "value": "12345678900" },
    { "code": "placa", "value": "ABC1D23" },
    { "code": "marca", "value": "Toyota" },
    { "code": "modelo", "value": "Corolla" },
    { "code": "ano_fabricacao", "value": "2022" }
  ]
}

Campo	Tipo	Obrig.	Descrição
`company_id`	UUID	Sim	ID da empresa fornecido pelo time Autovist
`flow_id`	UUID	Sim	ID do produto/fluxo configurado
`form`	Array	Sim	Pares code/value — estrutura definida pelo produto, consulte o time de suporte
`identifier`	String	Não	ID amigável — auto-gerado se omitido — deve ser único dentro da proposta
`process_id`	UUID	Não	Se omitido, criado automaticamente
`proposal_id`	UUID	Não	Se omitido, criado e vinculado ao processo automaticamente

ℹ️

Regra de process/proposal: Se informar apenas proposal_id, o sistema localiza o processo pai automaticamente. Se informar ambos, valida que a proposta pertence ao processo. Os campos do form[] variam por produto — solicite a lista ao time de suporte.

Response 201 — Criado com sucesso

{
  "inspection": {
    "id": "c94167ca-4d13-4510-aa5b-8ab55bd571d4",
    "created_at": "2026-01-15T10:00:00.000Z",
    "updated_at": "2026-01-15T10:00:00.000Z",
    "identifier": "PROP-2026-001",
    "hash": "ABC123XY",
    "status": "WAITING_SOLICITATIONS",
    "status_display": "Aguardando solicitações",
    "validity": "2026-01-29",
    "automatic_analysis_remote_id": null,
    "automatic_analysis_name": null,
    "company": {
      "id": "d21a529b-3549-4a35-b16b-c2e39c70147e",
      "remote_id": "...",
      "name": "Empresa Teste LTDA"
    },
    "flow": {
      "id": "a94f3bc1-1234-5678-90ab-cdef01234567",
      "remote_id": "...",
      "name": "Fluxo Automóveis"
    },
    "process": { "id": "...", "remote_id": "...", "name": "..." },
    "proposal": { "id": "...", "remote_id": "...", "name": "..." },
    "fields": ["..."],
    "market_value": null,
    "damages": [],
    "analysis_items": [],
    "observations": [],
    "responses": [],
    "apis": []
  }
}

Erros possíveis

HTTP	Código	Causa
`400`	ValidationError	Payload inválido, campos obrigatórios ausentes ou formato incorreto
`403`	UnauthorizedError	Usuário sem permissão `manage_processes` ou `is_admin`
`404`	NotFoundError	`flow_id`, `process_id` ou `proposal_id` inválido, ou sem acesso à empresa
`409`	ConflictError	`identifier` já existe dentro da mesma proposta

4.3 Cancelar Vistoria

POST https://staging-process.autovist.com.br/api/v1/inspections/{id}/cancel/

Cancela uma vistoria ativa. Somente vistorias nos status elegíveis podem ser canceladas. O parâmetro {id} é o UUID da vistoria retornado na criação.

Response 200

{
  "code": "INSPECTION_UPDATED",
  "message": "Inspection updated successfully"
}

Status elegíveis para cancelamento

WAITING_SOLICITATIONS WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION WAITING_FOR_INITIAL_API_QUERIES WAITING_FOR_SCHEDULE WAITING_FOR_RESCHEDULE

4.4 Ciclo de Status da Vistoria

A Autovist possui até 22 status distintos ao longo do ciclo de vida de uma vistoria. A ordenação de status é configurável pelo time Autovist — cada produto pode ter um fluxo diferente conforme as regras de negócio do cliente.

💡

O diagrama abaixo representa o fluxo padrão (default) aplicado na maioria das configurações. Status opcionais são exibidos na tabela ao lado — ative-os conforme sua necessidade entrando em contato com suporte@autovist.com.br.

flowchart TD S1["① WAITING_SOLICITATIONS\nAguardando solicitações\n(status inicial)"] --> S2["② PARTIALLY_RECEIVED\nParcialmente recebido"] S2 --> S3["③ WAITING_FOR_PROCESSING\nAguardando processamento"] S3 --> S4["③ WAITING_FOR_RISK_ANALYSIS\nAguardando análise de risco"] S4 --> S5["④ UNDER_ANALYSIS\nEm análise"] S5 -->|analista solicita\nmais informações| S6["⑤ WAITING_FOR_ADDITIONAL_SOLICITATIONS\nAguardando solicitações adicionais"] S6 --> S7["⑥ PARTIALLY_RECEIVED_ADDITIONAL_SOLICITATIONS\nParcialmente recebido — Adicionais"] S7 --> S8["⑦ WAITING_FOR_PROCESSING_ADDITIONAL_SOLICITATIONS\nAguardando processamento — Adicionais"] S8 --> S4 S5 --> AP["⑧ APPROVED\n✅ Aprovado"] S5 --> DI["⑧ DISAPPROVED\n❌ Reprovado"] S5 --> SU["⑧ SUBJECT_TO_ANALYSIS\n⏳ Sujeito à análise"] S1 -.->|cancelamento| CA["⑧ CANCELED\nCancelado"] S1 -.->|expiração sem análise| OVW["⑧ OUT_OF_VALIDITY_DATE_WITHOUT_ANALYSIS\nFrustrado sem análise"] S5 -.->|expiração com análise| OV["⑧ OUT_OF_VALIDITY_DATE\nFrustrado"] style S1 fill:#eff6ff,stroke:#3b82f6,color:#1d4ed8 style AP fill:#f0fdf4,stroke:#16a34a,color:#14532d style DI fill:#fef2f2,stroke:#dc2626,color:#991b1b style SU fill:#fffbeb,stroke:#d97706,color:#92400e style CA fill:#f1f5f9,stroke:#94a3b8,color:#475569 style OVW fill:#f1f5f9,stroke:#94a3b8,color:#475569 style OV fill:#f1f5f9,stroke:#94a3b8,color:#475569

⚙️ Status Opcionais

Disponíveis conforme a regra de negócio do produto. Para ativar algum deles, entre em contato:

✉️ suporte@autovist.com.br

Status	Descrição
`WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION`	Triagem das informações iniciais
`WAITING_FOR_INITIAL_API_QUERIES`	Consultas API iniciais
`WAITING_FOR_SCHEDULE`	Aguardando agendamento
`WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION`	Triagem das informações recebidas
`WAITING_FOR_RISK_ANALYSIS_API_QUERIES`	Consultas API de análise de risco
`WAITING_FOR_RESCHEDULE`	Aguardando reagendamento
`WAITING_STATUS`	Aguardando status
`WAITING_FOR_AUTOMATIC_ANALYSIS`	Análise automática (IA)

Ver todos os 22 status com descrição completa

Ordem	Status	Descrição	Tipo
①	`WAITING_SOLICITATIONS`	Aguardando solicitações	Default
②	`PARTIALLY_RECEIVED`	Parcialmente recebido	Default
③	`WAITING_FOR_PROCESSING`	Aguardando processamento	Default
③	`WAITING_FOR_RISK_ANALYSIS`	Aguardando análise de risco	Default
④	`UNDER_ANALYSIS`	Em análise	Default
⑤	`WAITING_FOR_ADDITIONAL_SOLICITATIONS`	Aguardando solicitações adicionais	Default
⑥	`PARTIALLY_RECEIVED_ADDITIONAL_SOLICITATIONS`	Parcialmente recebido — Adicionais	Default
⑦	`WAITING_FOR_PROCESSING_ADDITIONAL_SOLICITATIONS`	Aguardando processamento — Adicionais	Default
⑧	`APPROVED`	✅ Aprovado	Default
⑧	`DISAPPROVED`	❌ Reprovado	Default
⑧	`SUBJECT_TO_ANALYSIS`	⏳ Sujeito à análise	Default
⑧	`CANCELED`	Cancelado	Default
⑧	`OUT_OF_VALIDITY_DATE`	Frustrado (expirado com análise)	Default
⑧	`OUT_OF_VALIDITY_DATE_WITHOUT_ANALYSIS`	Frustrado sem análise	Default
—	`WAITING_FOR_ANALYSIS_OF_INITIAL_INFORMATION`	Triagem das informações iniciais	Opcional
—	`WAITING_FOR_INITIAL_API_QUERIES`	Aguardando consultas iniciais	Opcional
—	`WAITING_FOR_SCHEDULE`	Aguardando agendamento	Opcional
—	`WAITING_FOR_ANALYSIS_OF_RECEIVED_INFORMATION`	Triagem das informações recebidas	Opcional
—	`WAITING_FOR_RISK_ANALYSIS_API_QUERIES`	Consultas API de análise de risco	Opcional
—	`WAITING_FOR_RESCHEDULE`	Aguardando reagendamento	Opcional
—	`WAITING_STATUS`	Aguardando status	Opcional
—	`WAITING_FOR_AUTOMATIC_ANALYSIS`	Análise automática (IA)	Opcional

Fase 5

Testes na API

Execute os cenários abaixo no ambiente de staging para garantir que a integração está correta antes de avançar para webhooks e go-live.

🧪 Autenticação

Login com credenciais válidas → Verificar que access e refresh são retornados
Refresh do token → Verificar que novo access é retornado sem novo login
Chamada protegida sem token → Esperar 401 ou 403
Chamada com token expirado → Verificar que o fluxo de refresh funciona

🧪 Criar Vistoria

Payload válido → Retorno 201 com inspection.id e status WAITING_SOLICITATIONS
Sem company_id → Esperar 400
Sem flow_id → Esperar 400
flow_id inexistente → Esperar 404
company_id de outra empresa → Esperar 404
Usuário sem permissão → Esperar 403
Mesmo identifier na mesma proposta → Esperar 409
Sem process_id e proposal_id → Verificar que são criados automaticamente

🧪 Cancelamento e Laudo

Cancelar em status elegível → Retorno 200 e status CANCELED
Cancelar em status não elegível → Esperar erro de validação
Após vistoria concluída → POST no pdf-report → Verificar download do PDF

🧪 Webhooks

Receber webhook em status intermediário (ex: WAITING_FOR_RISK_ANALYSIS) → Verificar que pdf_report_url está nulo
Receber webhook em status de finalização → Verificar que pdf_report_url está preenchido
Verificar que o campo status muda corretamente a cada notificação recebida
Simular recebimento do mesmo webhook duas vezes → Verificar que a lógica de idempotência funciona corretamente

Fase 6

Webhooks

O webhook é o principal mecanismo de notificação da Autovist. O sistema realiza um POST para a URL configurada a cada mudança de status — tanto nas transições intermediárias quanto nos status de finalização. Isso permite que o seu sistema acompanhe o ciclo completo da vistoria em tempo real, reagindo a cada etapa do processo.

💡

O webhook não dispara apenas na conclusão. Ele é acionado em todos os status de transição e finalização configurados no produto. Utilize o campo status do payload para identificar em qual etapa a vistoria se encontra e decidir como processar a notificação.

flowchart LR A["Mudança de\nStatus da\nVistoria"] --> B["Sistema\nAutovist\nPrepara Payload"] B --> C["POST para\nsua URL\nconfigurada"] C --> D["Seu sistema\nrecebe\npayload JSON"] D --> E{"Verificar\nstatus"} E -->|status final\nAPPROVED etc| F["Extrair\npdf_report_url"] E -->|status intermediário| G["Atualizar\nestado\ninterno"] F --> H["POST\nDownload\nLaudo PDF"] style H fill:#f0fdf4,stroke:#16a34a,color:#14532d style E fill:#fffbeb,stroke:#d97706,color:#92400e

⚠️

A URL de webhook deve ser informada ao time Autovist durante a Fase 1 para ser cadastrada no produto. Ela precisa ser um endpoint HTTPS que aceite requisições POST com corpo JSON.

📦 Estrutura Raiz do Payload

Campo	Tipo	Descrição
`id`	UUID	Identificador único da vistoria
`identifier`	String	Identificador amigável definido na criação
`hash`	String	Hash curto para localização rápida
`status`	String	Status atual da vistoria no momento do disparo (ex: `APPROVED`, `WAITING_FOR_RISK_ANALYSIS`)
`status_display`	String	Nome amigável do status em português (ex: `Aprovado`)
`pdf_report_url`	URL / Null	Endpoint autenticado para download do laudo PDF — preenchido somente nos status de finalização
`validity`	Date	Data de expiração da vistoria
`created_at` / `updated_at`	ISO 8601	Timestamps de criação e última atualização
`finished_at`	ISO 8601	Timestamp de conclusão da análise
`company`	Objeto	`id`, `remote_id`, `name`
`flow`	Objeto	`id`, `remote_id`, `name`
`finished_by`	Objeto	Analista que finalizou: `id`, `remote_id`, `name`
`market_value`	Objeto	Avaliação de valor de mercado (ver detalhe abaixo)
`fields`	Array	Respostas do formulário preenchido na criação
`damages`	Array	Danos identificados com custos de reparo
`analysis_items`	Array	Checklist de análise de risco com resultados
`observations`	Array	Observações do analista (internas e externas)
`responses`	Array	Mídias e respostas enviadas pelo vistoriador
`apis`	Array	Resultados das APIs externas configuradas no produto

market_value — Valor de Mercado

Campo	Tipo	Descrição
`model`	String	Referência do modelo na tabela de mercado
`percentage`	Decimal	Percentual aplicado (ex: 80.00 = 80%)
`fipe_value_to_consider`	Number	Valor de referência FIPE em R$
`manual_value_to_consider`	Number	Valor manual informado pelo analista
`fipe_considered_value`	Number	Valor FIPE após percentual
`manual_considered_value`	Number	Valor manual após percentual

damages[] — Danos e Custos de Reparo

Campo	Descrição
`is_active`	Se o dano é considerado no cálculo final de risco
`item_description`	Componente afetado (ex: "Porta Dianteira Esquerda")
`damage_description`	Tipo de dano (ex: "Superfície avariada")
`repair_description`	Ação de reparo (ex: "Substituição do componente")
`size`	Extensão/dimensão do dano
`value`	Custo estimado de reparo em R$
`mechanic_minutes`	Tempo estimado (min) — mecânica
`painting_minutes`	Tempo estimado (min) — pintura
`electrical_minutes`	Tempo estimado (min) — elétrica
`bodywork_minutes`	Tempo estimado (min) — funilaria
`upholstery_minutes`	Tempo estimado (min) — estofamento

fields[] — Campos do Formulário

Campo	Descrição
`code`	Código do campo (ex: `cpf`, `placa`)
`label`	Rótulo exibido ao usuário
`value`	Valor preenchido na criação
`type`	Tipo semântico (ex: `FINAL_CLIENT_EMAIL`)
`format`	`TEXT`, `NUMBER` ou `DATE`
`fieldset`	Agrupamento lógico (ex: "Cadastro de Clientes")
`required`	Se o campo era obrigatório
`immutable`	Se não pode ser alterado após criação

analysis_items[] — Checklist de Análise de Risco

Campo	Descrição
`solicitation_label`	Título da solicitação avaliada (ex: "Fotos do Painel")
`section`	Seção do checklist
`description`	Observação do analista sobre o item
`action`	Resultado: `APPROVED`, `DISAPPROVED`, etc.
`is_active`	Se o item é considerado na análise final

observations[] — Observações do Analista

Campo	Descrição
`type`	`EXTERNAL` (visível ao cliente) ou `INTERNAL`
`content`	Texto da observação
`files`	Arquivos de evidência: `domain` + `path`
`created_by_id`	ID do analista que registrou

responses[] — Mídias e Respostas do Vistoriador

Campo	Descrição
`label`	Nome da solicitação (ex: "Foto Ângulo Frontal")
`type`	`IMAGE` \| `QUESTION` \| `TERM`
`category`	Categoria da solicitação (ver lista abaixo)
`additional`	Se foi solicitação adicional pedida pelo analista
`files[]`	Arquivos: `url.domain` + `url.path`, hash e geolocalização
`question`	Para QUESTION: tipo (BINARY/TEXT/MULTI) e resposta
`term`	Para TERM: `term_file_url` e `accepted` (true/false)

Categorias disponíveis

apis[] — Resultados de APIs Externas

ℹ️

O conteúdo do array apis[] varia de acordo com as APIs externas contratadas e configuradas no produto. Cada objeto representa o resultado de uma consulta externa realizada automaticamente durante o ciclo de vida da vistoria. A documentação específica é fornecida separadamente pelo time de suporte.

🔒 Recomendações de Segurança para Webhook

Utilize sempre HTTPS no endpoint receptor
Responda com HTTP 200 rapidamente — processe o payload em background
Valide o campo status antes de processar — o webhook dispara em múltiplos momentos do ciclo de vida
Implemente idempotência usando a combinação de id + status para evitar reprocessamento duplicado
Baixe o laudo PDF (pdf_report_url) somente quando o status for de finalização (APPROVED, DISAPPROVED, SUBJECT_TO_ANALYSIS)
Implemente retry/reprocessamento para falhas na recepção

Fase 7

Resgate do Laudo Final (PDF)

Quando a vistoria atinge um status de finalização (APPROVED, DISAPPROVED ou SUBJECT_TO_ANALYSIS), o sistema gera automaticamente o laudo completo em PDF. O link de download é entregue no payload do webhook, no campo pdf_report_url. Em webhooks de status intermediário, esse campo pode retornar nulo.

POST https://staging-process.autovist.com.br/api/v1/inspections/create/{id}/pdf-report

Download do laudo em PDF. O {id} é o UUID da vistoria. A resposta é arquivo binário (application/pdf).

Header obrigatório

{
  "Authorization": "Bearer {seu_access_token}"
}

ℹ️

Como obter a URL: O campo pdf_report_url no payload do webhook já contém a URL completa com o ID correto. Basta fazer o POST com o header de autorização para receber o arquivo binário.

O laudo contém

Fase 8

Planejamento do Go-Live

Após validar todos os fluxos no ambiente de staging, planeje a entrada em produção com o time Autovist. Esta etapa requer disponibilização dos IDs e credenciais de produção pelo time de suporte.

🧪 Staging

https://staging-authentication.autovist.com.br

https://staging-process.autovist.com.br

IDs e credenciais exclusivos para testes.

🚀 Produção

https://authentication.autovist.com.br

https://process.autovist.com.br

IDs e credenciais de produção fornecidos pelo time Autovist no go-live.

💡 Recomendações Operacionais em Produção

Implemente renovação proativa do access token antes da expiração de 1 hora
Garanta alta disponibilidade do endpoint de recepção de webhooks
Monitore os status retornados — não trate apenas o caminho feliz
Armazene o inspection.id de cada vistoria para rastreabilidade
Utilize o campo identifier para vincular a vistoria ao seu sistema interno

🤝

Suporte & Sucesso do Cliente — disponível durante todo o processo

suporte@autovist.com.br

Do Onboarding ao Go-Livecom a Autovist

Visão Geral da Jornada

Alinhamento Inicial

Plataforma — Primeiro Contato

Login na Plataforma

Criar Nova Vistoria

Obter o Link da Vistoria

Realizar a Vistoria no Webapp

Acessar a Tela de Análise de Risco

Registrar Danos e Calcular Valor de Mercado

Completar o Checklist de Análise

Gerar o Laudo e a Decisão Final

Ambiente de Staging

🧪 Staging / UAT

🚀 Produção

Integração via API

4.1 Autenticação

4.2 Criar Vistoria

4.3 Cancelar Vistoria

4.4 Ciclo de Status da Vistoria

Testes na API

Webhooks

Resgate do Laudo Final (PDF)

Planejamento do Go-Live

🧪 Staging

🚀 Produção

Do Onboarding ao Go-Live
com a Autovist