证件照开放平台

API 文档

对外接口基于 API Key 鉴权,每次成功调用扣除 1 次额度。

鉴权

所有接口在请求头携带:

X-API-Key: ak_live_xxxxxxxx

1. 生成证件照

POST https://cxz.zjzmei.top/api/v1/idphoto Content-Type: multipart/form-data X-API-Key: <你的Key> file=照片.jpg spec=yipian|ercun|xiaoyipian|xiaocun bg=white|blue|red layout=0|1 format=jpg|png (默认 jpg)

成功返回图片(默认 JPG,可指定 png);若请求头 Accept 含 application/json,则返回 JSON(含 base64 图片及 format 字段)。

2. 连通性检测

GET https://cxz.zjzmei.top/api/v1/ping X-API-Key: <你的Key>

返回用户名与剩余次数。

示例(curl)

curl -F "file=@photo.jpg" -F "spec=yipian" -F "bg=blue" \ -H "X-API-Key: ak_live_xxx" \ https://cxz.zjzmei.top/api/v1/idphoto -o out.png

状态码:401 密钥错误 · 402 次数不足 · 500 引擎错误 · 200 成功。