Merge pull request #65 from Authing/feat/add-captcha-code

Feat/add captcha code

Author: lixpng

README.md

@@ -25,7 +25,7 @@ This SDK is built upon [Authing Management API(v3)](https://api.authing.cn/opena
   <dependency>
       <groupId>cn.authing</groupId>
       <artifactId>authing-java-sdk</artifactId>
-      <version>3.1.5</version>
+      <version>3.1.9</version>
   </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>cn.authing</groupId>
     <artifactId>authing-java-sdk</artifactId>
-    <version>3.1.8</version>
+    <version>3.1.9</version>
 
     <name>Authing Java SDK</name>
     <description>java backend sdk for authing</description>

src/main/java/cn/authing/sdk/java/client/AuthenticationClient.java

@@ -2480,4 +2480,15 @@ public CommonResponseDto pubtEvent(String eventCode, Object data) {
         return deserialize(response, CommonResponseDto.class);
     }
 
+    /**
+     * 生成图形验证码
+     * @return
+     */
+    public CaptchaCodeRespDto getCaptchaCode() {
+        AuthingRequestConfig config = new AuthingRequestConfig();
+        config.setUrl("/api/v3/get-captcha-code");
+        config.setMethod("GET");
+        String response = request(config);
+        return deserialize(response, CaptchaCodeRespDto.class);
+    }
 }

src/main/java/cn/authing/sdk/java/dto/SignInOptionsDto.java

@@ -51,6 +51,11 @@ public class SignInOptionsDto {
      */
     @JsonProperty("captchaCode")
     private String captchaCode;
+    /**
+     * 获取 Captcha 图形验证码时，对应返回的 token，当传入 captchaCode 时，此参数必传。
+     */
+    @JsonProperty("captchaToken")
+    private String captchaToken;
     /**
      * 密码加密类型，支持使用 RSA256 和国密 SM2 算法进行加密。默认为 `none` 不加密。
      * - `none`: 不对密码进行加密，使用明文进行传输。
@@ -110,6 +115,14 @@ public void setCaptchaCode(String captchaCode) {
         this.captchaCode = captchaCode;
     }
 
+    public String getCaptchaToken() {
+        return captchaToken;
+    }
+
+    public void setCaptchaToken(String captchaToken) {
+        this.captchaToken = captchaToken;
+    }
+
     public PasswordEncryptType getPasswordEncryptType() {
         return passwordEncryptType;
     }

src/main/java/cn/authing/sdk/java/dto/authentication/CaptchaCodeDto.java

@@ -0,0 +1,33 @@
+package cn.authing.sdk.java.dto.authentication;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class CaptchaCodeDto {
+    /**
+     * 验证码图片 svg
+     */
+    @JsonProperty("captchaCodeSvg")
+    private String captchaCodeSvg;
+
+    /**
+     * 验证码对应 token，需要在登录接口中与用户输入的验证码一起提交
+     */
+    @JsonProperty("captchaToken")
+    private String captchaToken;
+
+    public String getCaptchaCodeSvg() {
+        return captchaCodeSvg;
+    }
+
+    public void setCaptchaCodeSvg(String captchaCodeSvg) {
+        this.captchaCodeSvg = captchaCodeSvg;
+    }
+
+    public String getCaptchaToken() {
+        return captchaToken;
+    }
+
+    public void setCaptchaToken(String captchaToken) {
+        this.captchaToken = captchaToken;
+    }
+}

src/main/java/cn/authing/sdk/java/dto/authentication/CaptchaCodeRespDto.java

@@ -0,0 +1,71 @@
+package cn.authing.sdk.java.dto.authentication;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class CaptchaCodeRespDto {
+    /**
+     * 业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
+     */
+    @JsonProperty("statusCode")
+    private Integer statusCode;
+    /**
+     * 描述信息
+     */
+    @JsonProperty("message")
+    private String message;
+    /**
+     * 细分错误码，可通过此错误码得到具体的错误类型（成功请求不返回）。详细错误码列表请见：[API Code 列表](https://api-explorer.authing.cn/?tag=group/%E5%BC%80%E5%8F%91%E5%87%86%E5%A4%87#tag/%E5%BC%80%E5%8F%91%E5%87%86%E5%A4%87/%E9%94%99%E8%AF%AF%E5%A4%84%E7%90%86/apiCode)
+     */
+    @JsonProperty("apiCode")
+    private Integer apiCode;
+    /**
+     * 请求 ID。当请求失败时会返回。
+     */
+    @JsonProperty("requestId")
+    private String requestId;
+    /**
+     * 响应数据
+     */
+    @JsonProperty("data")
+    private CaptchaCodeDto data;
+
+    public Integer getStatusCode() {
+        return statusCode;
+    }
+
+    public void setStatusCode(Integer statusCode) {
+        this.statusCode = statusCode;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+
+    public Integer getApiCode() {
+        return apiCode;
+    }
+
+    public void setApiCode(Integer apiCode) {
+        this.apiCode = apiCode;
+    }
+
+    public String getRequestId() {
+        return requestId;
+    }
+
+    public void setRequestId(String requestId) {
+        this.requestId = requestId;
+    }
+
+    public CaptchaCodeDto getData() {
+        return data;
+    }
+
+    public void setData(CaptchaCodeDto data) {
+        this.data = data;
+    }
+}