API 错误
IaaS API 的所有错误响应都使用相同的响应体。HTTP 状态码和 code 说明发生了什么;code 的前缀说明错误发生在哪个领 域。
错误响应体格式
| 字段 | 类型 | 说明 |
|---|---|---|
title | string | 错误的简短名称,英文。 |
description | string | 英文说明。在校验错误中,会指出校验失败的字段。 |
translation | string | 葡萄牙语说明。 |
code | string | 三个字母表示领域,后跟六位数字。请在错误处理中使用此字段。 |
示例:没有写入权限的管理人集成调用 POST。
{
"title": "Manager does not have permission to access this endpoint",
"description": "Manager does not have permission to access this endpoint",
"translation": "Gestor nao tem permissão para acessar esse endpoint",
"code": "MIT000017"
}
请根据 HTTP 状态码和 code 处理错误。title、description 和 translation 的文本可能会变化。
code 前缀
| 前缀 | 错误发生的位置 |
|---|---|
MIT | 管理人主机(manager-api):认证、权限和路由。 |
CIT | 顾问主机(consultant-api):认证、权限和路由。 |
AIT | 转让方主机(assignor-api):认证、权限和路由。 |
QIT | 通用错误,可出现在任何主机或服务:路由不存在、方法不被接受、请求体无效、内部错误。 |
SET | 资产结算(/settlement)。 |
TRC | 应收账款转让(/trade_receivables)。 |
TRF | 转让文件(/trade_receivables_files)。 |
TRR | 资产出售与回购(/trade_resolve)。 |
TTR | 公共债券交易单(/trade_treasury)。 |
ASR | 转让方准入(/assignor_registry)。 |
ASS | 转让方(/assignor)。 |
ACT | 转让合同(/assignment_contract)。 |
AAM | 应收账款补充协议(/asset_amendment)。 |
ADF | 资产文件(/asset_document_files)。 |
BSC | Boleto(/bankslip_collection)。 |
CSH | 账户与对账单(/cash_account)。 |
TSF | 内部转账(/transfer)。 |
TRV | 交易冲正(/transaction_reversal)。 |
CMP | 投资组合构成(/composition)。 |
WLT | 投资组合(/wallet)。 |
EXP | 费用(/expense)。 |
VRG | 供应商登记(/vendor_registry)。 |
ECT | 费用合同(/expense_contract)。 |
IVR | 投资者登记(/investor_registry)。 |
IAD | 加入协议(/investor_adhesion)。 |
QTA | 份额(/quota)。 |
QOF | 发行控制(/quota_offering_control)。 |
TFQ | 作为资产的基金份额(/trade_fund_quota)。 |
400 且 code 为 QIT000001 表示请求体无效:有问题的字段会在 description 中给出。
认证
请求头、API 密钥和签名相关的错误(*000007 至 *000016 以及 *000020)及其修正方法,请参阅认证测试。
权限与路由
请求通过认证后,主机会检查您的集成是否可以调用该路由。缺少权限时返回 401,而不是 403:当 code 为以下之一时,不要去排查签名错误。
| 状态 | code | 发生情形 | 处理方式 |
|---|---|---|---|
| 401 | MIT000017 | 管理人集成没有该路由所需的权限:读取、写入或两者。 | 查看端点页面“适用范围”中的权限,以及集成页面 权限(Permissões) 中的状态 。参见开通集成权限。 |
| 401 | CIT000018 | 顾问与该基金(fund_class_key)没有有效关联,或在该基金中没有该路由所需的权限。 | 检查 fund_class_key 以及“适用范围”中标明的权限。顾问的权限按基金授予。如果权限显示为 由集成团队开通,则无法在门户中配置:请发送邮件至 integracao.dtvm@qitech.com.br 申请开通。 |
| 401 | AIT000017 | 转让方集成没有该路由所需的读取或写入权限。 | 请联系 integracao.dtvm@qitech.com.br。 |
| 400 | *000009 | 集成已停用。 | 重新启用集成(方法)或联系集成团队。 |
| 404 | QIT000404 | 该主机未开放此路径。 | 对于已文档化的路由,几乎都是使用了其他角色的基础 URL:请查看页面的“适用范围”以及您角色的基础 URL。同时检查不含 base_url 的路径。 |
| 405 | QIT000405 | 该路径在主机上存在,但不支持此方法。 | 请在端点页面核对方法。 |