Difference between revisions of "Developer Resources"

From WHMCS Documentation
Line 1: Line 1:
−
For developers, WHMCS has all the capabilities you might need to allow you to customize, integrate & extend the core system into your own website & applications.
+
Resources for developers including how-to guides, api documentation and code samples.
  
−
__TOC__
+
<html>
−
==Display Customisation==
+
<br />
 +
<div class="row">
 +
<div class="col-md-4 text-center">
  
−
Help & information relating to the customisation of templates and language files within WHMCS.
+
<i class="fa fa-cube fa-4x"></i>
 +
<h2>Modules</h2>
 +
<p>Extend WHMCS functionality by creating a module.</p>
 +
<a href="http://docs.whmcs.com/Creating_Modules" class="btn btn-info">Create a module</a><br />
 +
<a href="https://github.com/whmcs" target="_blank" class="btn btn-default">Code Samples (Github)</a>
  
−
*'''[[Template Syntax]]'''
+
</div>
−
*'''[[Client_Area_Template_Files|Client Area Templates]]'''
+
<div class="col-md-4 text-center">
−
*'''[[Admin_Area_Template_Files|Admin Area Templates]]'''
 
−
*'''[[Order Form Templates]]'''
 
−
*'''[[PDF Invoice]]'''
 
−
*'''[[Language Files|Client Area Language Files]]'''
 
−
*'''[[Admin_Area#Multi-Language|Admin Area Language Files]]'''
 
  
−
==Extending Functionality==
+
<i class="fa fa-gear fa-4x"></i>
 +
<h2>Hooks</h2>
 +
<p>Tie into events as they occur inside WHMCS.</p>
 +
<a href="http://docs.whmcs.com/Hooks" class="btn btn-info">Hooks Overview</a><br />
 +
<a href="http://docs.whmcs.com/Hooks:Index" class="btn btn-default">Hook Directory</a>
  
−
Detailed developer documentation & resources for how to create modules, pages and use hooks to integrate & extend system functionality.
+
</div>
 +
<div class="col-md-4 text-center">
  
−
*'''[[Useful Functions for Devs]]''' - an overview of some core functions developers can make use of in custom code
+
<i class="fa fa-code fa-4x"></i>
−
*'''[[Provisioning Module Developer Docs]]''' - docs for creating your own product/server provisioning modules
+
<h2>API</h2>
−
*'''[[Registrar Module Developer Docs]]''' - guide & template for creating a domain registrar module for WHMCS
+
<p>Interact with WHMCS from custom code & third party applications.</p>
−
*'''[[Gateway Module Developer Docs]]''' - guide & template for creating a payment gateway module for WHMCS
+
<a href="http://docs.whmcs.com/API" class="btn btn-default">API Overview</a>
−
*'''[[SQL Helper Functions]]''' - how to use the MySQL functions built into WHMCS
+
<a href="http://docs.whmcs.com/API:JSON_Sample_Code" class="btn btn-default">Sample Code</a>
−
*'''[[Addon Modules]]''' - addon modules allow you to create both custom admin pages and hooks for additional functionality
+
<a href="http://docs.whmcs.com/API:Functions" class="btn btn-info">Function Directory</a>
−
*'''[[Creating Pages]]''' - demonstrates how to create custom pages for the client area
+
<a href="http://docs.whmcs.com/API:Internal_API" class="btn btn-default">Internal API</a>
−
*'''[[Reports]]''' - explains how to modify or create new reports
 
−
*'''[[Action Hooks]]''' - hooks allow you to run your own code when various events & actions occur inside WHMCS
 
−
*'''[[AutoAuth]]''' - for automatically authenticating clients from custom code
 
  
−
==API==
+
</div>
 +
</div>
  
−
The API docs provide details and code samples for interfacing with the WHMCS API from both within WHMCS itself, and outside it from custom code or third party applications.
+
<br /><br />
  
−
*'''[[API|API Information]]''' - overview & setup info
+
<div class="row">
−
*'''[[API:Internal_API|Internal API]]''' - details & example code for calling the WHMCS API locally from within WHMCS modules & files
+
<div class="col-md-4 text-center">
−
*'''[[API:XML_Sample_Code|Example XML Method Code]]''' - sample PHP code for calling & interpreting the XML responses of the WHMCS API
+
 
−
*'''[[API:JSON_Sample_Code|Example JSON Method Code]]''' - sample PHP code for calling & interpreting JSON responses from the WHMCS API
+
<i class="fa fa-paint-brush fa-4x"></i>
−
*'''[[API:Functions|API Functions]]''' - individual documentation for all the functions of the API
+
<h2>Templates</h2>
 +
<p>Design and develop custom themes.</p>
 +
<a href="http://docs.whmcs.com/Customising_the_Six_Theme" class="btn btn-info">Customising WHMCS</a>
 +
<a href="http://docs.whmcs.com/Template_Syntax" class="btn btn-info">Template Language/Syntax Reference</a>
 +
<a href="http://docs.whmcs.com/Client_Area_Template_Files" class="btn btn-default">Client Area</a>
 +
<a href="http://docs.whmcs.com/Admin_Area_Template_Files" class="btn btn-default">Admin Area</a>
 +
<a href="http://docs.whmcs.com/Order_Form_Templates" class="btn btn-default">Order Forms</a>
 +
<a href="http://docs.whmcs.com/PDF_Invoice" class="btn btn-default">PDF Invoice</a>
 +
 
 +
</div>
 +
<div class="col-md-4 text-center">
 +
 
 +
<i class="fa fa-lock fa-4x"></i>
 +
<h2>OAuth/OpenID</h2>
 +
<p>APIs for Authenticating with WHMCS</p>
 +
<a href="http://docs.whmcs.com/WHMCS_Single_Sign-On_Developer_Guide" class="btn btn-info">WHMCS Single Sign-On</a>
 +
<a href="http://docs.whmcs.com/OpenID_Connect_Developer_Guide" class="btn btn-info">OpenID Connect</a>
 +
 
 +
</div>
 +
<div class="col-md-4 text-center">
 +
 
 +
<i class="fa fa-file-text-o fa-4x"></i>
 +
<h2>Reference Docs</h2>
 +
<p>The following articles are available for reference.</p>
 +
 
 +
<a href="http://docs.whmcs.com/Internal_Functions" class="btn btn-default">Internal Functions</a>
 +
<a href="http://docs.whmcs.com/Interacting_With_The_Database" class="btn btn-default">Interacting with the Database</a>
 +
<a href="http://docs.whmcs.com/Creating_Pages" class="btn btn-default">Creating Your Own Pages</a>
 +
<a href="http://docs.whmcs.com/Language_Files" class="btn btn-default">Language Files</a>
 +
 
 +
</div>
 +
</div>
 +
 
 +
<h1>App Store</h1>
 +
<p>Find out <a href="http://www.whmcs.com/appstore">How it Works</a> and How to <a href="http://www.whmcs.com/members/communityaddons.php?action=add">Submit a Listing</a>.</p>
 +
 
 +
</html>
 +
 
 +
__NOTOC__

Revision as of 11:24, 15 December 2015

Resources for developers including how-to guides, api documentation and code samples.


Modules

Extend WHMCS functionality by creating a module.

Create a module
Code Samples (Github)

Hooks

Tie into events as they occur inside WHMCS.

Hooks Overview
Hook Directory

API

Interact with WHMCS from custom code & third party applications.

API Overview Sample Code Function Directory Internal API


Templates

Design and develop custom themes.

Customising WHMCS Template Language/Syntax Reference Client Area Admin Area Order Forms PDF Invoice

OAuth/OpenID

APIs for Authenticating with WHMCS

WHMCS Single Sign-On OpenID Connect

Reference Docs

The following articles are available for reference.

Internal Functions Interacting with the Database Creating Your Own Pages Language Files

App Store

Find out How it Works and How to Submit a Listing.


Retrieved from "http://3.17.75.209/index.php?title=Developer_Resources&oldid=17146"