LY 码本录 Java API 使用文档

# LY 码本录 Java API 使用文档
*码本API*

LY 码本录支持使用 Java API 的方法进行一些站点操作，本文中我们将学习如何使用它！

## 目录

[TOC]

![fe36580146895b04e74862d6b32f74b34f7a2a7c3441e1606055fa0c1251f72e](https://diskmirror.lingyuzhao.top/DiskMirrorBackEnd/FsCrud/downLoad/18/Binary?fileName=Article/Image/4013988878370430/fe36580146895b04e74862d6b32f74b34f7a2a7c3441e1606055fa0c1251f72e.jpg)

## 最新的 token

> 系统token`aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Db25maWcvc2VlQ29uZmlnQnlBUEk=`

> 登录token`aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Vc2VyQ29udHJvbGxlci9sb2dpbkJ5QXBp`

# CodeBookApi

在这里您可以使用 码本 API 来操作您的码本名下所有平台的一些资源。

> 本库还在不断的开发，目前提供的是部分服务~

## 获取到依赖库

直接使用 Maven 来引入依赖。

```xml

<dependencies>
    <dependency>
        <groupId>io.github.BeardedManZhao</groupId>
        <artifactId>CodeBookApi</artifactId>
        <version>1.19</version>
    </dependency>
</dependencies>
```

## 码本录 API

对接 LY 码本录 的 API。

### 登录 API

您首先需要在这里登录您的码本录账号。

#### 获取到当前用户对象

```java
import top.lingyuzhao.codeBook.api.lyMbl.LyMblApi;
import top.lingyuzhao.codeBook.api.lyMbl.User;

import java.io.IOException;

/**
 * @author 赵凌宇
 */
public class MAIN {

    public static void main(String[] args) throws IOException {
        try (LyMblApi lyMblApi = LyMblApi.login(
                "您的用户名", "您的密码",
                // 系统认证 token 一般不需要修改 可以在网页上查看
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Db25maWcvc2VlQ29uZmlnQnlBUEk=",
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Vc2VyQ29udHJvbGxlci9sb2dpbkJ5QXBp"
        )) {
            // 获取到用户对象
            User user = lyMblApi.getUser();
            // 可以查看用户信息
            System.out.println(user.getId());
            System.out.println(user.getName());
            System.out.println(user.getAcc());
        }
    }
}
```

#### 获取到当前用户对象的三方认证账号信息

```java
import top.lingyuzhao.codeBook.api.lyMbl.LyMblApi;
import top.lingyuzhao.codeBook.api.lyMbl.ThirdPartyAuth;

import java.io.IOException;

/**
 * @author 赵凌宇
 */
public class MAIN {

    public static void handler(LyMblApi lyMblApi) {
        // 获取到三方认证信息
        ThirdPartyAuth codeBookAPI = lyMblApi.thirdPartyAuth("codeBookAPI");
        // 可以在这里查看三方认证信息的值
        // 用户在码本录中的ID
        System.out.println(codeBookAPI.getSystemUserID());
        // 第三方系统名称
        System.out.println(codeBookAPI.getServiceProviderName());
        // 第三方系统内的用户ID，三方系统可以使用这个来进行对接
        System.out.println(codeBookAPI.getThirdPartyUserID());
        // 第三方系统内的用户KEY，三方系统可以使用这个来进行对接
        System.out.println(codeBookAPI.getThirdPartyKey());
    }

    public static void main(String[] args) throws IOException {
        try (LyMblApi lyMblApi = LyMblApi.login(
                "您的用户名", "您的密码",
                // 系统认证 token 一般不需要修改 可以在网页上查看
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Db25maWcvc2VlQ29uZmlnQnlBUEk=",
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Vc2VyQ29udHJvbGxlci9sb2dpbkJ5QXBp"
        )) {
            handler(lyMblApi);
        }
    }
}
```

#### 码本录 发送邮件

```java
import top.lingyuzhao.codeBook.api.lyMbl.LyMblApi;

import java.io.IOException;

/**
 * @author 赵凌宇
 */
public class MAIN {

    public static void main(String[] args) throws IOException {
        try (final LyMblApi lyMblApi = LyMblApi.login(
                "您的用户名", "您的密码",
                // 系统认证 token 一般不需要修改 可以在网页上查看
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Db25maWcvc2VlQ29uZmlnQnlBUEk=",
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Vc2VyQ29udHJvbGxlci9sb2dpbkJ5QXBp"
        )) {
            // 发送邮件给 1 号用户
            if (lyMblApi.sendMailTo(
                    "61", "<p>Hello World</p><p>可以使用这个格式发送邮件哦</p><p>这是一封测试邮件</p>"
            )) {
                System.out.println("发送成功");
            }
        }
    }
}
```

### 三方登录授权 API

#### 获取到登录授权链接

这个链接是需要在浏览器中被已经登录的用户访问的！！！

```java
import top.lingyuzhao.codeBook.api.lyMbl.LyMblApi;

/**
 * @author 赵凌宇
 */
public class MAIN {

    public static void main(String[] args) {
        final String codeBookAPI = LyMblApi.getLoginAuthorizationLink("codeBookAPI", "http://localhost:8080/test");
        System.out.println(codeBookAPI);
    }
}
```

#### 校验授权是否有效

这里的 `new ThirdPartyAuth("0", "codeBookAPI", "123123", "12123123")` 是一个示例，在实际的 http 服务中，这个不需要您手动实例化，而是交给我们的码本服务器给您的控制器回复！

```java
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import top.lingyuzhao.codeBook.api.lyMbl.LyMblApi;
import top.lingyuzhao.codeBook.api.lyMbl.ThirdPartyAuth;

import java.io.IOException;

/**
 * @author 赵凌宇
 */
public class MAIN {

    public static void main(String[] args) {

        try (CloseableHttpClient aDefault = HttpClients.createDefault()) {
            boolean b = LyMblApi.checkThirdPartyAuth(aDefault, new ThirdPartyAuth("0", "codeBookAPI", "123123", "12123123"));
            // 返回 true 表示授权有效
            System.out.println(b);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

    }
}
```

### 码本录 内置盘镜 API

您可以使用下面的方法来直接操作码本录的内置盘镜。当然，您只能操作您自己的哦~

```java
import com.alibaba.fastjson2.JSONObject;
import top.lingyuzhao.codeBook.api.lyMbl.DiskMirrorApi;
import top.lingyuzhao.codeBook.api.lyMbl.LyMblApi;
import top.lingyuzhao.codeBook.api.lyMbl.User;
import top.lingyuzhao.diskMirror.core.Adapter;
import top.lingyuzhao.diskMirror.core.DiskMirrorRequest;

import java.io.IOException;

/**
 * @author 赵凌宇
 */
public class MAIN {

    public static void main(String[] args) throws IOException {
        final LyMblApi lyMblApi = LyMblApi.login(
                "您的用户名", "您的密码",
                // 系统认证 token 一般不需要修改 可以在网页上查看
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Db25maWcvc2VlQ29uZmlnQnlBUEk=",
                "aHR0cHM6Ly9sc2IubGluZ3l1emhhby50b3A6NDAwNDMvTFMtV2ViQmFja0VuZC9Vc2VyQ29udHJvbGxlci9sb2dpbkJ5QXBp"
        );
        // 获取到盘镜适配器
        DiskMirrorApi diskMirrorApi = lyMblApi.getDiskMirrorApi();
        Adapter adapter = diskMirrorApi.getAdapter();

        // 获取到盘镜请求对象
        DiskMirrorRequest diskMirrorRequest = diskMirrorApi.getDiskMirrorRequest();
        // 使用 getUrls 方法获取盘镜文件系统结构
        JSONObject urls = adapter.getUrls(diskMirrorRequest);
        System.out.println(urls);

        // 可以删除一个在 盘镜 的文件 或目录 在 setFileName 直接设置就可以，目录也在这里设置哦！虽然名字是 fileName~
        diskMirrorRequest.setFileName("/chatFiles");
        JSONObject remove = adapter.remove(diskMirrorRequest);
        System.out.println(remove);
        
        lyMblApi.close();
        adapter.close();
    }
}
```

------
***操作记录***
作者：[LY小助手](https://www.lingyuzhao.top//index.html?search=18 "LY小助手")
操作时间：2025-02-23 18:10:39 星期日 【时区：UTC 8】
事件描述备注：保存/发布
 中国 天津 
[](如果不需要此记录可以手动删除，每次保存都会自动的追加记录)