README

这是为Hiddify提供的第三方库

📑 TODO

• API

  • 其他

    • 是否连接
    • 获取系统统计信息

  • 用户

    • 获取用户列表
    • 获取用户信息 + 服务器和时间剩余
    • 添加用户
    • 删除用户
    • 更新用户
    • 删除非活动用户
    • 获取可用的Telegram代理

  • 管理员

    • 获取管理员列表
    • 添加新管理员
    • 删除管理员

  • 单元测试

    • 添加用户
    • 删除用户

• 支持更多语言

  • PHP 🐘 代码 | 文档
  • NodeJS ✨ 代码 | 文档 由 Mr_artan -> Telegram
  • Python 🐍 *需要帮助
  • MORE...

• MISC

  • 编写文档
  • 错误处理

💡 PHP 使用方法

<?php

include('src/HiddifyApi.php');

$api = new hiddifyApi(
    '', //! https://domain.com
    '', //! hiddify hidden path
    '' //! admin secret
);

$api->is_connected(); // return bool

$api->getSystemStats(); // return array


/////----------- USER API -----------\\\\\

//! if success return user uuid else return false
$api->user()->create(name: 'MrWebappDeveloper',
                    package_days: 30,
                    package_size: 30,
                    telegram_id: null, // optional
                    comment: null, // optional
                    resetMod: 'no_reset'); // 'no_reset' default
                    
//! if success return user uuid else return false
$api->user()->update(name: 'MrWebappDeveloper',
                    package_days: 30,
                    package_size: 30,
                    uuid: "user uuid"
                    telegram_id: null, // optional
                    comment: null, // optional
                    resetMod: 'no_reset'); // 'no_reset' default
                    
$api->user()->delete(string $uuid); // returns bool

$api->user()->list(); // return array

$api->user()->find(string $uuid); // returns user details in an array and returns null if can't find.

?>

🤝 贡献

对本项目的贡献总是受欢迎的！如果您遇到任何问题，请随时提交pull请求或创建问题。

📃 许可证

本项目采用MIT许可证。有关更多信息，请参阅LICENSE文件。