https://github.com/petebishwhip/whmcsapi

A PHP API Wrapper for the default WHMCS API commands
https://github.com/petebishwhip/whmcsapi

php php73 whmcs whmcs-api

Last synced: 3 months ago
JSON representation

A PHP API Wrapper for the default WHMCS API commands

• Host: GitHub
• URL: https://github.com/petebishwhip/whmcsapi
• Owner: PeteBishwhip
• License: mit
• Archived: true
• Created: 2020-03-05T11:21:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-27T19:33:11.000Z (over 4 years ago)
• Last Synced: 2024-09-28T19:42:46.296Z (3 months ago)
• Topics: php, php73, whmcs, whmcs-api
• Language: PHP
• Size: 108 KB
• Stars: 5
• Watchers: 4
• Forks: 3
• Open Issues: 108
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# WHMCSAPI - The WHMCS, PHP API Wrapper

[![Build Status](https://travis-ci.org/PeteBishwhip/WHMCSAPI.svg?branch=master)](https://travis-ci.org/PeteBishwhip/WHMCSAPI)

[![Mergify Status][mergify-status]][mergify]

This project is simple. It is an object-oriented library of the WHMCS API functions.

To use this wrapper is simple.

# Requirements

- PHP 7.3 (It may work on lower. I only test on PHP 7.3 due to dev-dependencies)

- Composer

- WHMCS Installation (and License!) - [Buy Here](https://www.whmcs.com/members/aff.php?aff=40067)

## Usage

First, import the library. As WHMCSAPI is currently in alpha/beta status, set the minimum version to `1.0@alpha`:

```bash

composer require PeteBishwhip/WHMCSAPI:"^1.0@alpha"

```

After you have imported the library, initialize the wrapper by providing three values.

| Variable       | Description                                          |

|:-------------- |:----------------------------------------------------:|

| $apiIdentifier | Your API Identifier                                  |

| $apiSecret     | Your API Secret                                      |

| $whmcsUrl      | Your WHMCS URL (e.g. https://example.com/whmcs/)     |

```php

use WHMCSAPI\WHMCSAPI;

// $whmcsApi = new WHMCSAPI('abc123', '123cba', 'https://example.com/whmcs/');

$whmcsApi = new WHMCSAPI($apiIdentifier, $apiSecret, $whmcsUrl);

```

After initializing the library, use `command` to set the API command you want to use:

```php

try {

    $whmcsApi->command('AcceptOrder');

} catch (\WHMCSAPI\Exception\FunctionNotFound $e) {

    // Perform error handling here

    // You can retrieve the error with

    // $e->getMessage();

}

```

If 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.

From there, you can set any variables as documented in the WHMCS Developer Documentation:

```php

$whmcsApi->orderid = 25;

```

When ready, you can finally execute the command:

```php

$result = $whmcsApi->execute();

```

## Contributing

Please see CONTRIBUTING.md for advice and guidance.

[mergify]: https://mergify.io

[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/PeteBishwhip/WHMCSAPI&style=flat