Consulta de análises do fornecedor
Use estas chamadas para acompanhar o andamento do cadastro depois do envio da análise: a análise pela chave, a análise vigente de um fornecedor, a lista de análises e o histórico de mudanças de status.
Listar análises
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
Parâmetros de consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
status | string | Não | Status da análise. Aceita vários valores separados por vírgula. Ver status da análise. |
vendor_key | string | Não | Só as análises deste fornecedor. |
owner_agent_key | string | Não | Só as análises dos fornecedores cujo dono é este agente. |
limit | integer | Não | Itens por página, de 0 a 1000. Padrão: 10. |
page | integer | Não | Página, a partir de 0. Padrão: 0. |
Devolve as análises da mais recente para a mais antiga. Entram só os fornecedores visíveis para você: os que você criou, o que representa você e os que você vê pelo contrato de uma consultoria.
GET /vendor_registry/analyses?status=in_manual_analysis,in_compliance_analysis
Resposta
{
"data": [],
"limit": 10,
"page": 0,
"is_last_page": true
}
Cada item de data é uma análise completa, na estrutura descrita em atributos da análise, com vendor aninhado.
Consultar análise por chave
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
analysis_key | string | Chave da análise (UUID). |
Resposta
Uma análise, na estrutura descrita em atributos da análise. Numa análise reprovada, reproval_reason e reproval_details dizem o motivo; em in_manual_analysis, ai_pending_reasons em analysis_data lista as pendências apontadas pela validação automática.
Consultar análise vigente do fornecedor
Devolve a análise mais recente que não está reproved nem canceled: a análise em curso, se houver, ou a última aprovada. Se todas as análises foram reprovadas ou canceladas, devolve a mais recente.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
Resposta
Uma análise, na mesma estrutura da consulta por chave.
Histórico de status do fornecedor
Lista todas as mudanças de status de todas as análises do fornecedor, da mais antiga para a mais recente. Não é paginado.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
Resposta
{
"data": [
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "pending_submission",
"event_datetime": "2026-11-01 12:00:00.418302",
"author_type": "qitech",
"author_name": null,
"reproval_reason": null,
"reproval_details": null
},
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "sent_to_analysis",
"event_datetime": "2026-11-01 12:30:05.913477",
"author_type": "manager",
"author_name": "Maria Souza",
"reproval_reason": null,
"reproval_details": null
},
{
"analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
"status": "reproved",
"event_datetime": "2026-11-02 09:10:41.207815",
"author_type": "qitech",
"author_name": null,
"reproval_reason": "missing_documents",
"reproval_details": "Falta o comprovante de endereço atualizado."
}
]
}
Atributos de cada evento
| Campo | Tipo | Descrição |
|---|---|---|
analysis_key | string | Análise do evento. |
status | string | Status que a análise assumiu. |
event_datetime | string | Momento da mudança. |
author_type | string | manager ou consultant quando a mudança foi feita por um usuário do portal; qitech nos demais casos, inclusive transições automáticas, decisões da QI Tech e chamadas feitas pela API com chave de integração. |
author_name | string | Nome do usuário do portal, ou null quando author_type é qitech. |
reproval_reason | string | Preenchido só no último evento reproved de cada análise; null nos demais. |
reproval_details | string | Preenchido só no último evento reproved de cada análise; null nos demais. |
Resumo do cadastro
Conta os seus fornecedores por status e as análises por situação num período. Só entram os fornecedores que são seus: os que você criou e o que representa você.
São duas chamadas: GET /vendor_registry/agent devolve o seu agent_key, que vai no caminho de GET /vendor_registry/agent/{agent_key}/summary.
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Integração ativa |
URL base de cada host: Ambientes (Hosts).
{
"agent_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"agent_type": "manager",
"name": "EXEMPLO GESTORA LTDA",
"document_number": "22.333.444/0001-81"
}
Parâmetros de consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
date_range_start | string | Não | Início do período, YYYY-MM-DD. |
date_range_end | string | Não | Fim do período, YYYY-MM-DD. |
Se faltar qualquer uma das duas datas, o período vai do primeiro dia do mês corrente até hoje.
{
"period": {
"start": "2026-11-01",
"end": "2026-11-09"
},
"vendors": {
"total": 12,
"active": 7,
"inactive": 1,
"pending_analysis": 3,
"expired": 1
},
"analyses": {
"total": 12,
"pending_submission": 2,
"sent_to_analysis": 1,
"in_manual_analysis": 1,
"in_compliance_analysis": 0,
"approved": 7,
"reproved": 1,
"canceled": 0,
"approved_in_period": 2,
"pending_annotation": 1
}
}
Atributos do resumo
| Campo | Descrição |
|---|---|
vendors.* | Fornecedores do agente por status, em todo o histórico. |
analyses.approved | Fornecedores cuja última análise está aprovada, em todo o histórico. |
analyses.pending_submission a analyses.canceled | Fornecedores cuja última análise está nesse status e mudou de status dentro do período. |
analyses.total | Soma dos sete status acima. |
analyses.approved_in_period | Aprovações ocorridas no período, de qualquer análise. |
analyses.pending_annotation | Fornecedores cujo apontamento mais recente da última análise está opened. |
Erros
code | Quando acontece |
|---|---|
VRG000007 | A analysis_key não existe. |
VRG000014 | A vendor_key não existe ou o fornecedor não é visível para você. Também quando a analysis_key existe, mas é de um fornecedor que você não vê. |
VRG000043 | Sua gestora ainda não está cadastrada no serviço de fornecedores. Fale com integracao.dtvm@qitech.com.br. |
Resumo de outro agente
O agent_key do caminho não é o seu. Use o que GET /vendor_registry/agent devolve.
{
"title": "Forbidden",
"description": "The selected agent is not allowed to access this agent's resources.",
"translation": "O agente selecionado nao tem permissao para acessar os recursos deste agente.",
"code": "VRG000033"
}
code | Quando acontece |
|---|---|
QIT000010 | limit, page ou uma das datas está fora do formato. |
Erros de autenticação, permissão e host: veja Erros da API.