OkayAPI API: App.Captcha.Create

OkayAPI Docs

API Path: /api/App/Captcha/Create

API Description: 生成一个新的验证码，可在小白开放平台进行相关参数配置。返回时可选择直接输出验证码图片，也可以选择返回数据。请注意，需要保管好captcha_id（直接输出图片时通过COOKIE返回），以便校验时核对。

API Traffic

HTTP/HTTPS

Protocol

GET/POST

Method

UTF-8

Charset

JSON

Response

Parameter	Type	Required	Default	Note	Description
HTTP_APPKEY	String	Required		MIN: 32	Common Put Your APPKEY
return_format	Enum	Optaion	output	Range: output/data	验证码返回格式，output表示直接输出验证码图片，data表示返回base64后的验证码图片数据

Submit Type:

Form Data

JSON RAW(application/json;charset=UTF-8)

JSON RAW

KEY	REQUIRED	VALUE
app_key	*Required
return_format	Option

KEY	Type	Description
err_code	Int	操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
err_msg	String	错误提示信息，err_code非0时参考此提示信息
captcha_id	String	验证码唯一ID，用于校验时核对（return_format=data时返回此字段）
captcha_img	String	验证码图片base64后的数据（return_format=data时返回此字段）