{"id":15026346,"url":"https://github.com/petebishwhip/whmcsapi","last_synced_at":"2025-10-03T23:32:34.173Z","repository":{"id":57038063,"uuid":"245143766","full_name":"PeteBishwhip/WHMCSAPI","owner":"PeteBishwhip","description":"A PHP API Wrapper for the default WHMCS API commands","archived":true,"fork":false,"pushed_at":"2020-06-27T19:33:11.000Z","size":111,"stargazers_count":5,"open_issues_count":108,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-17T01:12:07.396Z","etag":null,"topics":["php","php73","whmcs","whmcs-api"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PeteBishwhip.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2020-03-05T11:21:02.000Z","updated_at":"2023-10-05T11:52:41.000Z","dependencies_parsed_at":"2022-08-24T06:41:03.435Z","dependency_job_id":null,"html_url":"https://github.com/PeteBishwhip/WHMCSAPI","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeteBishwhip%2FWHMCSAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeteBishwhip%2FWHMCSAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeteBishwhip%2FWHMCSAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeteBishwhip%2FWHMCSAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PeteBishwhip","download_url":"https://codeload.github.com/PeteBishwhip/WHMCSAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235204448,"owners_count":18952326,"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":["php","php73","whmcs","whmcs-api"],"created_at":"2024-09-24T20:04:19.398Z","updated_at":"2025-10-03T23:32:28.870Z","avatar_url":"https://github.com/PeteBishwhip.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WHMCSAPI - The WHMCS, PHP API Wrapper\n[![Build Status](https://travis-ci.org/PeteBishwhip/WHMCSAPI.svg?branch=master)](https://travis-ci.org/PeteBishwhip/WHMCSAPI)\n[![Mergify Status][mergify-status]][mergify]\n\nThis project is simple. It is an object-oriented library of the WHMCS API functions.\nTo use this wrapper is simple.\n\n# Requirements\n- PHP 7.3 (It may work on lower. I only test on PHP 7.3 due to dev-dependencies)\n- Composer\n- WHMCS Installation (and License!) - [Buy Here](https://www.whmcs.com/members/aff.php?aff=40067)\n\n## Usage\nFirst, import the library. As WHMCSAPI is currently in alpha/beta status, set the minimum version to `1.0@alpha`:\n```bash\ncomposer require PeteBishwhip/WHMCSAPI:\"^1.0@alpha\"\n```\n\nAfter you have imported the library, initialize the wrapper by providing three values.\n\n| Variable       | Description                                          |\n|:-------------- |:----------------------------------------------------:|\n| $apiIdentifier | Your API Identifier                                  |\n| $apiSecret     | Your API Secret                                      |\n| $whmcsUrl      | Your WHMCS URL (e.g. https://example.com/whmcs/)     |\n\n```php\nuse WHMCSAPI\\WHMCSAPI;\n\n// $whmcsApi = new WHMCSAPI('abc123', '123cba', 'https://example.com/whmcs/');\n$whmcsApi = new WHMCSAPI($apiIdentifier, $apiSecret, $whmcsUrl);\n```\n\nAfter initializing the library, use `command` to set the API command you want to use:\n\n```php\ntry {\n    $whmcsApi-\u003ecommand('AcceptOrder');\n} catch (\\WHMCSAPI\\Exception\\FunctionNotFound $e) {\n    // Perform error handling here\n    // You can retrieve the error with\n    // $e-\u003egetMessage();\n}\n```\nIf the command is not available, a `\\WHMCSAPI\\Exception\\FunctionNotFound` exception will be thrown to allow for catching errors. If you want to perform all actions in the same try/catch, catch `WHMCSAPI\\Exception\\Exception`. All exceptions extend from this.\n\nFrom there, you can set any variables as documented in the WHMCS Developer Documentation:\n\n```php\n$whmcsApi-\u003eorderid = 25;\n```\n\nWhen ready, you can finally execute the command:\n```php\n$result = $whmcsApi-\u003eexecute();\n```\n\n## Contributing\nPlease see CONTRIBUTING.md for advice and guidance.\n\n[mergify]: https://mergify.io\n[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/PeteBishwhip/WHMCSAPI\u0026style=flat\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetebishwhip%2Fwhmcsapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetebishwhip%2Fwhmcsapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetebishwhip%2Fwhmcsapi/lists"}