接入文档
金际分
金际分V1-A
金际分V1-A
# 金际分V1-A 接口文档
# 一、接口描述
该接口用于对单张图片进行风险查询，返回风险查询结果
# 二、接口地址
https://api-sgp.yljz.com/finauth/v3/visual/riskscore
# 三、调用方法
POST（需使用form-data格式请求）
# 四、请求参数
| 可选/必选 | 参数英文名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | sign | String | 调用此API客户的签名，具体的签名产生方式请查阅”鉴权说明“文档 |
| 必选 | sign_version | String | 签名算法版本，请传递：hmac_sha1 |
| 必选 | image | File | 待检测图片（不能超过2M） |
# 五、产品出参
| 参数英文名 | 参数中文名 | 类型 | 参数说明 |
|---|---|---|---|
| request_id | 请求ID | String | 用于区分每一次请求的唯一的字符串。除了发生错误404(API_NOT_FOUND)外，此字段必定返回 |
| time_used | 请求耗时 | Int | 整个请求所花费的时间，单位为毫秒 |
| error_message | 错误信息 | String | 当http状态码非200时返回 |
| visual_risk | 金际分 | String | 取值范围【300,850】，分数越大，信用越好 |
# 六、当前API特有的ERROR_MESSAGE（不需要依赖人脸，所以没有nofacefound）
| HTTP状态码 | 错误信息 | 说明 |
|---|---|---|
| 200 | 正常值，服务器成功返回用户请求的数据 | |
| 400 | INVALID_IMAGE | image超出2M |
| 400 | IMAGE_ERROR_UNSUPPORTED_FORMAT | 上传的图像无法解析 |
| 400 | MISSING_ARGUMENTS: <key> | 缺少某个必选参数 |
| 400 |
BAD_ARGUMENTS:<key> |
某个参数解析出错（比如必须是数字，但是输入的是非数字字符串; 或者长度过长，etc.） |
| 400 | REQUEST_ERROR | 请求异常 |
| 401 | AUTHENTICATION_ERROR | 签名无效 |
| 403 | CONCURRENCY_LIMIT_EXCEEDED | 并发数超过限制 |
| 403 | AUTHORIZATION_ERROR:<reason> |
api_key被停用、调用次数超限、没有调用此API的权限，或者没有以当前方式调用此API的权限。<reason>取值： - API_KEY_BE_DISCONTINUED：api_key被停用 - LIMIT_REACHED：这个api_key对当前API的调用量达到上限。仅当api_key为测试key - DENIED：无权限调用当前API - EXPIRED_SIGN：签名已过期 - INVALID_SIGN：无效签名 |
| 404 | API_NOT_FOUND | 所调用的API不存在 |
| 500 |
INTERNAL_ERROR |
服务器内部错误，当此类错误发生时请再次请求，如果持续出现此类错误，请及时联系技术支持团队 |
# 七、示例代码
1、成功示例
{
"request_id": "1716883855,a080638e-2483-424f-8d35-3566bd9c421b",
"time_used": 1672,
"visual_risk": "724"
}
2、失败示例
ERROR（签名无效、并发超限）
{
"error": "AUTHORIZATION_ERROR: INVALID_SIGN"
}
ERROR _MESSAGE （图片大小超限、找不到人脸等）
{
"request_id": "1716884001,57e093f8-f923-44f3-8ee0-4df5e0e79b31",
"time_used": 0,
"error_message": "MISSING_ARGUMENTS:image"
}