跳到主要内容

查询供应商审核

在提交审核之后,使用这些调用跟踪登记进度:按 key 查询审核、查询供应商的当前有效审核、审核列表以及状态变更历史。

列出审核​

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api有效集成

各主机的 Base URL:环境(主机)。

ENDPOINT
/vendor_registry/analyses
方法
GET

查询参数​

参数类型必填说明
statusstring否审核状态。可传入多个值,以逗号分隔。参见审核状态。
vendor_keystring否仅返回该供应商的审核。
owner_agent_keystring否仅返回由该主体拥有的供应商的审核。
limitinteger否每页条数,0 至 1000。默认值:10。
pageinteger否页码,从 0 开始。默认值:0。

返回的审核按从新到旧排序。仅包含您可见的供应商:您自己创建的、代表您自己的,以及您通过顾问的合同看到的。

Exemplo de chamada
GET /vendor_registry/analyses?status=in_manual_analysis,in_compliance_analysis

响应​

STATUS
200
Corpo da resposta
{
"data": [],
"limit": 10,
"page": 0,
"is_last_page": true
}

data 中的每一项都是完整的审核,结构见审核属性,并嵌套 vendor。

按 key 查询审核​

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api有效集成

各主机的 Base URL:环境(主机)。

ENDPOINT
/vendor_registry/analysis/{analysis_key}
方法
GET

路径参数​

参数类型说明
analysis_keystring审核的 key(UUID)。

响应​

STATUS
200

返回一个审核,结构见审核属性。对于被拒绝的审核,reproval_reason 和 reproval_details 说明原因;处于 in_manual_analysis 时,analysis_data 中的 ai_pending_reasons 列出自动校验指出的待处理事项。

查询供应商的当前有效审核​

返回最近一次既非 reproved 也非 canceled 的审核:如有进行中的审核则返回该审核,否则返回最近一次通过的审核。如果所有审核都已被拒绝或取消,则返回最近的一次。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api有效集成

各主机的 Base URL:环境(主机)。

ENDPOINT
/vendor_registry/vendor/{vendor_key}/current_analysis
方法
GET

响应​

STATUS
200

返回一个审核,结构与按 key 查询相同。

供应商状态历史​

列出供应商所有审核的全部状态变更,按从旧到新排序。不分页。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api有效集成

各主机的 Base URL:环境(主机)。

ENDPOINT
/vendor_registry/vendor/{vendor_key}/status_events
方法
GET

响应​

STATUS
200
Corpo da 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."
}
]
}

每个事件的属性​

字段类型说明
analysis_keystring事件所属的审核。
statusstring审核变更后的状态。
event_datetimestring变更时间。
author_typestring变更由门户用户执行时为 manager 或 consultant;其他情况下为 qitech,包括自动状态变更、QI Tech 的决定以及使用集成密钥通过 API 发起的调用。
author_namestring门户用户的姓名;当 author_type 为 qitech 时为 null。
reproval_reasonstring仅在每个审核的最后一个 reproved 事件中填写;其他事件为 null。
reproval_detailsstring仅在每个审核的最后一个 reproved 事件中填写;其他事件为 null。

登记汇总​

按状态统计您的供应商数量,并按情况统计某一期间内的审核数量。仅统计属于您的供应商:您创建的和代表您自己的。

共有两个调用:GET /vendor_registry/agent 返回您的 agent_key,该值用于 GET /vendor_registry/agent/{agent_key}/summary 的路径。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api有效集成

各主机的 Base URL:环境(主机)。

ENDPOINT
/vendor_registry/agent
方法
GET
Corpo da resposta
{
"agent_key": "a7498c6c-1893-42ec-a8f3-bc6ad0c6b52c",
"agent_type": "manager",
"name": "EXEMPLO GESTORA LTDA",
"document_number": "22.333.444/0001-81"
}
ENDPOINT
/vendor_registry/agent/{agent_key}/summary
方法
GET

查询参数​

参数类型必填说明
date_range_startstring否期间开始日期,YYYY-MM-DD。
date_range_endstring否期间结束日期,YYYY-MM-DD。

缺少任意一个日期时,期间为当月第一天至今天。

Corpo da resposta
{
"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
}
}

汇总属性​

字段说明
vendors.*该主体按状态统计的供应商数量,涵盖全部历史。
analyses.approved最近一次审核已通过的供应商数量,涵盖全部历史。
analyses.pending_submission 至 analyses.canceled最近一次审核处于该状态、且在期间内发生过状态变更的供应商数量。
analyses.total上述七个状态的总和。
analyses.approved_in_period期间内发生的审核通过次数,包含任意审核。
analyses.pending_annotation最近一次审核中最新审核意见为 opened 的供应商数量。

错误​

STATUS
404
code发生情形
VRG000007该 analysis_key 不存在。
VRG000014该 vendor_key 不存在,或您看不到该供应商。analysis_key 存在但属于您看不到的供应商时也返回此错误。
VRG000043您所属的管理人尚未在供应商服务中登记。请联系 integracao.dtvm@qitech.com.br。
STATUS
403
其他主体的汇总

路径中的 agent_key 不是您的。请使用 GET /vendor_registry/agent 返回的值。

{
"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"
}
STATUS
400
code发生情形
QIT000010limit、page 或某个日期的格式不正确。

认证、权限和主机相关的错误:参见 API 错误。