mrwebappdeveloper/hiddify-api-php

PHP package (packagist) for interaction with Hiddify panel remotely.

1.3.1 2024-03-11 06:50 UTC

Requires

• mrwebappdeveloper/html-query-selector: 1.2.0

Requires (Dev)

• fakerphp/faker: ^1.23
• irannewtech/tool: ^1.2
• phpunit/phpunit: ^11.0
• vlucas/phpdotenv: ^5.6

MIT

• anonymous

README

This is a third-party library For Hiddify

📑 TODO :

• API

  • Misc

    • Is Conected
    • Get System Stats

  • User

    • Get user list
    • Get User Info + Servers & Time Remain
    • Add User
    • Del User
    • Update User
    • Del deactive Usres
    • Get Telegram Proxy If available

  • Admin

    • Get Admin list
    • Add New Admin
    • Del admin

  • Unit Tests

    • Add User
    • Del User

• Support More Language

  • PHP 🐘 Code | Doc
  • NodeJS ✨ Code | Doc By Mr_artan -> Telegram
  • Python 🐍 *need help
  • MORE...

• MISC

  • Write Doc
  • Error Handling

💡 Usage 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.

?>

🤝 Contributing :

Contributions to this project are always welcome! Feel free to submit a pull request or create an issue if you encounter any problems.

📃 License :

This project is licensed under the MIT License. See the LICENSE file for more information.