yunlogin-cloud-sdk

v1.1.4

Published

9 months ago

云浏览器sdk

0High
0Medium
0Low

fanis

云浏览器SDK

云浏览器SDK，用于管理云浏览器实例

安装

npm install yunlogin-cloud-sdk

初始化

import cloudSdk from 'yunlogin-cloud-sdk'

const sdk = new cloudSdk("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6InRlc3QiLCJ1c2VySWQiOiJmYW5jaGVu*****");

功能函数

操作详细，请查看下面函数操作实例

获取列表

const getList = async () => {
  const list = await sdk.getList();
};

创建实例

const create = async () => {
  const res = await sdk.create({
    sessionName: "实例名称2",
    productId: "test",
    expiredType: 1,
    expired: 0,
    browser: {
      system: "Windows 10",
      uaVersion: "122",
      publicIp: "192.168.0.171",
      ipChannel: "ipdata",
      kernel: "chrome",
      kernelVersion: "122",
    },
  });
};

只有 role 为 owner 才能创建实例

请求参数

cookies 结构

browser 结构

{
  "sessionName": "实例名称",
  "productId": "产品ID",
  "expiredType": 1,
  "expired": 0,
  "browser": {
    "headless": "1",
    "system": "",
    "uaVersion": "",
    "publicIp": "192.168.0.171",
    "ipChannel": "",
    "kernel": "chrome",
    "kernelVersion": "127",
    "proxy": {
      "protocol": "http",
      "host": "192.168.0.171",
      "port": 10809,
      "userName": "",
      "password": ""
    },
    "site_accounts": [
      {
        "user": "",
        "pwd": "",
        "site": ""
      }
    ]
  }
}

返回值

{
  "reqId": "a0d29fff-1315-44ee-8ad7-7905d6726a4f",
  "code": 200,
  "msg": "OK",
  "data": {
    "id": 6,
    "appID": "",
    "userId": "",
    "companyId": "",
    "sessionId": "7fe752d6369745e4affb4c645e4faba2",
    "sessionName": "local",
    "productId": "hztest",
    "cloudId": "fcd1d3f39cba4a94b95d255c4e5efd64",
    "browserUrl": "",
    "apiKey": "7fe752d6369745e4affb4c645e4faba2",
    "status": 2,
    "healthy": 1,
    "expiredType": 1,
    "expired": 0,
    "totalDuration": 14045,
    "duration": 0,
    "info": null,
    "browser": {
      "system": "Windows 11",
      "publicIp": "127.0.0.1",
      "kernel": "chrome",
      "kernelVersion": "127",
      "proxy": {
        "protocol": "",
        "host": "",
        "port": 0,
        "userName": "",
        "password": ""
      }
    },
    "country": "CN",
    "city": "CN"
  }
}

更新实例指纹

const update = async () => {
  const res = await sdk.update(
    "c78f137783584d18946955cac****",
    "fad77b07f127427da825d3df****",
    {
      flag: 0,
      sessionId: "fad77b07f127427da825d3df****",
      sessionName: "实例名称112233",
      browser: {
        system: "Windows 10",
        uaVersion: "122",
        publicIp: "192.168.0.171",
        ipChannel: "ipdata",
        kernel: "chrome",
        kernelVersion: "122",
      },
    }
  );
};

参数

| 名称 | 类型 | 是否必须 | 字段含义 | 备注 | | :------------ | :----- | :------- | :---------- | :---------------------------------------------------------------------- | | flag | int | 否 | 更新标识 | 0: 更新基础信息 2:更新指纹信息 4:更新代理信息 8:清除 cookie 16:清除缓存 |

cookies 结构

browser 结构

请求

{
  "flag": 0,
  "sessionId": "c61458b4d8464453b9f120dfbea736db",
  "sessionName": "实例名称",
  "browser": {
    "system": "",
    "uaVersion": "",
    "publicIp": "192.168.0.171",
    "ipChannel": "",
    "kernel": "chrome",
    "kernelVersion": "127",
    "proxy": {
      "protocol": "http",
      "host": "192.168.0.171",
      "port": 10809,
      "userName": "",
      "password": ""
    }
  }
}

interface

提供接口数据，方便用户快速使用

/** 环境信息 */
export interface EnvData {
    id: number;
    userId: string;
    companyId: string;
    apiKey: string;
    sessionId: string;
    /** 名称 */
    sessionName: string;
    productId: string;
    /**
     * 服务器类型
     *
     * @description 海外:包含“hwtest” 其他国内
     */
    cloudId: string;
    /** 到期类型  到期类型 1:不过期 2:到期时间 3:剩余时长（单位秒）*/
    expiredType: number;
    /** 到期时间 */
    expired: number;
    sessionLogId: number;
    /** rpa连接ws地址 */
    browserUrl: string;
    /**
     * 状态 1:运行 2:关闭 3:删除
     */
    status: number;
    checktime: string;
    errorNum: number;
    duration: number;
    clientNum: number;
    info: null;
    /** 环境信息 */
    browser: any;
    /** 更新日期 */
    updatedAt: string;
    /** 创建日期 */
    createdAt: string;
}
/** 环境列表数据 */
export interface SessionListData {
    /** 环境列表信息 */
    list: envData[];
    /** 总数 */
    total: number;
    /** 每页显示条数 */
    pageSize: number;
    /** 当前页 */
    currentPage: number;
}
export interface SessionListResponse {
    reqId: string;
    /**
     * 状态码 200:成功
     */
    code: number;
    msg: "OK";
    /** 环境信息 */
    data: SessionListData;
}

// 请求接口 ********************************************
/** 账号信息 */
export interface IAccounts {
    /** 账号 */
    user: string;
    /** 密码 */
    pwd: string;
    /** 站点 */
    site: string;
}
/** 代理信息 */
export interface IProxy {
    /** 协议类型 */
    protocol: string;
    /** 地址 */
    host: string;
    /** 端口 */
    port: number;
    /** 账号 */
    userName: string;
    /** 密码 */
    password: string;
}

/** 环境信息 */
export interface IBrowser {
    /**
     * 操作系统
     *
     * @description 目前支持： Windows 7，Windows 8，Windows 8.1，Windows 10，Windows 11
     */
    system: string;
    /**
     * ua 大版本号
     * @description 范围 100-124
     */
    uaVersion?: string;
    /**
     * 公网 ip
     * @description 设置代理取代理里的 IP
     */
    publicIp: string;
    /**
     * ip 检测渠道
     * @description 可为空，枚举 ip2location，ipdata
     */
    ipChannel?: string;
    /**
     * 内核类型 chrome，firefox
     */
    kernel: string;
    /**
     * 内核版本 107,119,122
     */
    kernelVersion: string;
    /** 代理信息 */
    proxy?: IProxy;
    /** 账号信息 */
    site_accounts?: IAccounts[];
}

/** 环境创建入参 */
export interface ICreateReqParams {
    /** 实例名称 */
    sessionName: string;
    /** 产品 ID，决定主机所在的区域 */
    productId: string;
    /** 到期类型  1:不过期 2:到期时间 3:剩余时长（单位秒）*/
    expiredType: number;
    /**
     * 到期时间
     * @description 当 expiredType = 1 时 值为 Unix 时间戳，expiredType = 2 时为时长秒数
     */
    expired: number;
    /** 环境指纹信息 */
    browser: IBrowser;
}

/** 环境更新信息入参 */
export interface IUpdateReqParams {
    /**
     * 更新标识 0:更新基础信息 2:更新指纹信息 4:更新代理信息 8:清除 cookie 16:清除缓存
     */
    flag?: number;
    sessionId: string;
    sessionName: string;
    browser: IBrowser;
}

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

云浏览器SDK

安装

初始化

功能函数

获取列表

创建实例

请求参数

cookies 结构

browser 结构

返回值

更新实例指纹

参数

cookies 结构

browser 结构

interface