跳到主要内容

图像

在许多情况下,需要向我们的 API 发送图像,以执行 OCR、FaceMatch 和文档验证操作。为此,需要先上传图像,然后再将其发送进行分析。

使用 /image 端点发送图像后,将返回一个 GUID(全局唯一标识符)。该值应在后续调用中用于引用此图像。

上传

使用 cUrl 上传示例

    curl    -F "data=@path/to/local/file" \
-H "Authorization: EXAMPLE-OF-API-KEY" \
"https://api.caas.qitech.app/image?type=face"

Response Body
    {
"image_id": "f4b5337a-7b50-406e-8c8e-7d0e77b5aa02",
"image_size": "134232",
"image_dimensions": "630x230"
}

要发送图像,只需以 multipart/form-data 格式将 .jpeg 格式的图像通过 POST 请求发送至端点:

https://api.caas.qitech.app/api/image?type=$type

其中 $type 是图像的分类,必须按照以下枚举值之一发送(如果发送的图像不属于任何分类,请联系支持团队以添加):

  • face
  • driver_license
  • id
  • contract

发送后,将返回一个包含指向已发送图像的 GUID 的 JSON 对象。

文件检索

读取图像

    curl "https://api.caas.qitech.app/api/image/f4b5337a-7b50-406e-8c8e-7d0e77b5aa02/file" \
-H "Authorization: EXAMPLE-OF-API-KEY"

向 API 发送图像后,可以通过在端点发出经适当认证的 GET 请求来检索图像:

https://api.caas.qitech.app/api/image/{image_key}/file

其中 image_key 是图像发送时返回的值。

文件元数据检索

读取元数据

    curl "https://api.caas.qitech.app/api/image/f4b5337a-7b50-406e-8c8e-7d0e77b5aa02" \
-H "Authorization: EXAMPLE-OF-API-KEY"

向 API 发送图像后,可以使用以下端点检索图像的元数据:

https://api.caas.qitech.app/api/image/{image_key}

其中 image_key 是图像发送时返回的值。