petebishwhip / whmcsapi Goto Github PK

View Code? Open in Web Editor NEW

5.0 4.0 3.0 111 KB

A PHP API Wrapper for the default WHMCS API commands

License: MIT License

PHP 100.00%

whmcs whmcs-api php php73

whmcsapi's Introduction

WHMCSAPI - The WHMCS, PHP API Wrapper

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

Usage

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

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/)

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:

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:

$whmcsApi->orderid = 25;

When ready, you can finally execute the command:

$result = $whmcsApi->execute();

Contributing

Please see CONTRIBUTING.md for advice and guidance.

whmcsapi's People

Contributors

Stargazers

Watchers

Forkers

overwatchdata infinityonlinesolutions slaiddominio

whmcsapi's Issues

Implement DeleteAnnouncement function

Need to implement the DeleteAnnouncement API function.

Implement DeletePayMethod function

Need to implement the DeletePayMethod API function.

Implement AddTicketReply function

Need to implement the AddTicketReply API function.

Implement DeleteProjectTask function

Need to implement the DeleteProjectTask API function.

Implement CloseClient function

Need to implement the CloseClient API function.

Implement AddTransaction function

Need to implement the AddTransaction API function.

Implement DeleteContact function

Need to implement the DeleteContact API function.

Implement CreateProject function

Need to implement the CreateProject API function.

Implement CapturePayment function

Need to implement the CapturePayment API function.

Implement DeleteOrder function

Need to implement the DeleteOrder API function.

Write unit tests

Require a unit test for each API function available.

Should be in PHPUnit -> testing environment for connections to be established.

Implement DeleteTicket function

Need to implement the DeleteTicket API function.

Implement DomainGetLockingStatus function

Need to implement the DomainGetLockingStatus API function.

Implement AddPayMethod function

Need to implement the AddPayMethod API function.

Implement DomainUpdateLockingStatus function

Need to implement the DomainUpdateLockingStatus API function.

Implement CreateInvoice function

Need to implement the CreateInvoice API function.

Improve validation procedure for "ADDITIONAL_REQUIREMENTS"

Currently, there's an if statement for each validation type. This is less than ideal and was created in a hurry.

This can be improved with the validateInput method. We just need to pass the type of validation as well as the data. I just don't have time yet to do this.

e.g.:

$this->validateData($validationType, $data);

Implement DeleteTicketNote function

Need to implement the DeleteTicketNote API function.

Implement DomainToggleIdProtect function

Need to implement the DomainToggleIdProtect API function.

Implement DomainUpdateWhoisInfo function

Need to implement the DomainUpdateWhoisInfo API function.

Implement CreateQuote function

Need to implement the CreateQuote API function.

Implement AffiliateActivate function

Need to implement the AffiliateActivate API function.

Implement DomainUpdateNameservers function

Need to implement the DomainUpdateNameservers API function.

Implement DomainRegister function

Need to implement the DomainRegister API function.

Implement DomainGetWhoisInfo function

Need to implement the DomainGetWhoisInfo API function.

Add a debug method

This would likely be a boolean which defaults to false.

Before making an API call, a user could run

$whmcsApi->debug(true);

This would remain persistent for as long as the object does, or is set back to false.

Need to determine:

Where to log
Format to log
Exactly what data to log

-rw-r--r--   1 peterbishop  staff  392  6 Mar 14:49 AcceptOrder.php
-rw-r--r--   1 peterbishop  staff  278  6 Mar 14:49 AcceptQuote.php
-rw-r--r--   1 peterbishop  staff  437  6 Mar 14:49 ActivateModule.php
-rw-r--r--   1 peterbishop  staff  378  6 Mar 14:49 AddAnnouncement.php
-rw-r--r--   1 peterbishop  staff  380  6 Mar 14:49 AddBannedIp.php
-rw-r--r--   1 peterbishop  staff  653  6 Mar 14:49 AddBillableItem.php
-rw-r--r--   1 peterbishop  staff  429  6 Mar 18:58 AddCancelRequest.php
-rw-r--r--   1 peterbishop  staff  768  6 Mar 20:05 AddClient.php
-rw-r--r--   1 peterbishop  staff  344  6 Mar 22:00 AddClientNote.php
-rw-r--r--   1 peterbishop  staff  571  7 Mar 18:46 AddContact.php