README.md

# WHMCS API C# Wrapper

This is an library to comunicate with the WHMCS API<br/>
Currently these functions are already implemented

* [Add Client](https://github.com/hitmanpt/whmcs-api/wiki/AddClient%28%29)
* [Domain WhoIs](https://github.com/hitmanpt/whmcs-api/wiki/DomainWhoIs%28%29)
* [Get Clients Details](https://github.com/hitmanpt/whmcs-api/wiki/GetClientsDetails%28%29)
* [Get Clients Domains](https://github.com/hitmanpt/whmcs-api/wiki/GetClientsDomains%28%29)
* [Get Clients Products](https://github.com/hitmanpt/whmcs-api/wiki/GetClientsProducts%28%29)
* [Get Invoice](https://github.com/hitmanpt/whmcs-api/wiki/GetInvoice%28%29)
* [Get Invoices](https://github.com/hitmanpt/whmcs-api/wiki/GetInvoices%28%29)
* [Get Orders](https://github.com/hitmanpt/whmcs-api/wiki/GetOrders%28%29)
* [Get Transactions](https://github.com/hitmanpt/whmcs-api/wiki/GetTransactions%28%29)
* [Module Change Password](https://github.com/hitmanpt/whmcs-api/wiki/ModuleChangePassword%28%29)
* [Module Custom Command](https://github.com/hitmanpt/whmcs-api/wiki/ModuleCustomCommand%28%29)
* [Validate Login](https://github.com/hitmanpt/whmcs-api/wiki/ValidateLogin%28%29)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A3JFH2WA6U9YU)

How to install<br />
[NuGet](https://www.nuget.org/packages/WHMCS_API) Packet Manager Console on VisualStudio `Install-Package WHMCS_API`
<br />or<br />
<a href="https://github.com/hitmanpt/whmcs-api/releases">Releases</a> project page (need to also download Newtonsoft.Json if not already included on your project)

The implemented functions are designed to be very easy to use
The following code demonstrates to to implement the GetClientDetails on an ASP.net MVC app<br />
More information on the project Wiki <a href="https://github.com/hitmanpt/whmcs-api/wiki/Getting-Started">Getting Started</a>

```
using WHMCS-API;
namespace YOUR_APP
{
    public class YOUR_CLASS
    {
        [HttpPost]
        public ActionResult ClientDetails(int clientID)
        {
            string username = "WHMCS_USERNAME";
            string password = "WHMCS_PASSWORD";
            string accessKey = "WHNMCS_ACCESS_KEY";
            string whmcsUrl = "WHMCS_USERFRONTEND_URL"; //ex: https://example.com/client
            API api = new API(username, password, accessKey, whmcsUrl);
            ViewBag.UserDetails = api.GetClientsDetails(clientID, Stats: true); //The model passed is of type GetClientsDetails
            return View();
        }
    }
}
```

You can still use this library to call non implemented<br />
Read more at the project Wiki <a href="https://github.com/hitmanpt/whmcs-api/wiki/%5BAdvanced-Usage%5D-Unsuported-Actions">[Advanced Usage] Unsuported Actions</a>


You can also create custom functions of already implemented functions.<br />
Read more at the project Wiki <a href="https://github.com/hitmanpt/whmcs-api/wiki/%5BAdvanced-Usage%5D-Supported-Actions">[Advanced Usage] Supported Actions</a>


[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A3JFH2WA6U9YU)