{"id":17590714,"url":"https://github.com/26bz/whmcs-assistant-bot","last_synced_at":"2025-09-12T03:47:10.125Z","repository":{"id":258118820,"uuid":"872849088","full_name":"26bz/WHMCS-Assistant-Bot","owner":"26bz","description":"A Discord.js bot that allows you to use your WHMCS API directly in Discord securely.","archived":false,"fork":false,"pushed_at":"2024-10-16T03:50:02.000Z","size":666,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-22T21:35:38.604Z","etag":null,"topics":["discord-bot","discordjs","whmcs","whmcs-api"],"latest_commit_sha":null,"homepage":"https://builtbybit.com/resources/whmcs-assistant-bot.53098/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/26bz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-15T07:19:28.000Z","updated_at":"2024-10-16T03:50:06.000Z","dependencies_parsed_at":"2024-10-17T18:50:33.421Z","dependency_job_id":null,"html_url":"https://github.com/26bz/WHMCS-Assistant-Bot","commit_stats":null,"previous_names":["26bz/whmcs-assistant-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/26bz%2FWHMCS-Assistant-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/26bz%2FWHMCS-Assistant-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/26bz%2FWHMCS-Assistant-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/26bz%2FWHMCS-Assistant-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/26bz","download_url":"https://codeload.github.com/26bz/WHMCS-Assistant-Bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229003812,"owners_count":18004809,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discord-bot","discordjs","whmcs","whmcs-api"],"created_at":"2024-10-22T04:05:31.985Z","updated_at":"2024-12-10T04:23:36.930Z","avatar_url":"https://github.com/26bz.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"![Logo](https://github.com/26bz/WHMCS-Assistant-Bot/blob/main/logo.png)\n# WHMCS-Assistant-Bot\n\nThank you for purchasing WHMCS-Assistant-Bot! Follow the guide below to get your bot up and running.\n\n## Requirements\n\n1. **Discord Bot Setup**: Make sure your Discord bot is created through the Discord Developer Portal. If you're unfamiliar with this, refer to the [Discord Bot Setup Guide](https://discord.com/developers/docs/quick-start/getting-started).\n\n2. **Obtain Bot Credentials**: Collect the necessary credentials (bot token, client ID, etc.) and ensure they are added to your `.env` file.\n\n3. **WHMCS API IP Whitelist**: \n   - Go to your WHMCS dashboard: **System Settings** → **General Settings** → **Security**.\n   - Add your bot's IP address to the **API IP Access Restriction** section to authorize its use of the API.\n\n4. **WHMCS API Access Key**: \n   - Set up an API access key for WHMCS following [this guide](https://developers.whmcs.com/api/access-control/).\n   - Add the `WHMCS_API_ACCESS_KEY` to your `.env` file.\n\n5. **Explore Commands Names**: The available bot commands names can seen in the `commands` folder. \n\n6. **Configure WHMCS API**:\n   - In your WHMCS admin dashboard, go to **System Settings** → **API Credentials** → **API Roles**.\n   - Click **Create a New Role**, name it, and optionally add a description.\n   - Define which API actions this role is allowed to perform. Leave unchecked any actions you want to disallow.\n   - Click **Save**.\n\n7. **Generate API Credentials**:\n   - Go to the **API Credentials** tab and click **Generate New API Credential**.\n   - Select the admin user, add a description, and choose the role you just created.\n   - Click **Generate**.\n\n8. **Copy API Credentials**: You will receive the following credentials:\n   - `WHMCS_API_IDENTIFIER=`\n   - `WHMCS_API_SECRET=`\n   \n   Add these keys to your `.env` file.\n\n9. **Set API URL**: Ensure that the WHMCS API URL in your `.env` file is set to:  \n   ```\n   WHMCS_API_URL=https://billing.example.com/includes/api.php\n   ```\n\n## Additional Configurations\n\nIn the `utils/config.json` file, ensure the following values are updated:\n\n- `botOwnerIds: [\"\"],` // Replace with actual owner IDs\n- `adminIds: [\"ADMIN_ID_1\", \"ADMIN_ID_2\"],` // Replace with actual admin IDs\n- `moderatorIds: [\"MODERATOR_ID_1\", \"MODERATOR_ID_2\"],` // Replace with actual moderator IDs\n\n### Command Permission Levels\n\nEach command file has a `permissionLevel` setting. The permission levels are:\n\n- `1`: Owner (highest level)\n- `2`: Admin\n- `3`: Moderator (lowest level)\n\nUsers with a lower number (`1` or `2`) can execute commands set to a higher permission level (`3`). Adjust these based on your operational needs in the config.json.\n\n\n## Running the Bot\n\nTo start the bot, use the following command:\n\n```bash\nnode src/bot.js\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F26bz%2Fwhmcs-assistant-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F26bz%2Fwhmcs-assistant-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F26bz%2Fwhmcs-assistant-bot/lists"}