Feature Requests
Share ideas, discuss and vote on requests from other users in community

Custom API Support

Matthew Eli shared this idea 3 months ago
Under Consideration

Using information such as the link below provides, one can create custom APIs for WHMCS without much trouble, but there is no documentation from WHMCS for doing so. Additionally, any custom APIs are not exposed via the new API Roles area so they are more troublesome to implement. The ability to support this feature is already present in WHMCS; it's just a matter of providing documentation and at least one more function being exposed to add strings to the API roles list. Luckily, other people have documented it well enough to get started:


Feature request in short:

  • Support custom API directives by providing appropriate documentation
  • Provide patch notes for any changes made which might affect custom API implementations and standards
  • Allow custom API directives to be listed in the API Roles area in 7.4+

Currently it is possible to manipulate the API role in the database to add local support for custom APIs, but this is not desirable and may be patched in the future to remove support for non-standard API directives. Also, it would probably be preferred to hook this into plugins in some way so plugins can register functions with the API instead of the unsupported method using files in the api directory.

Comments (2)


Hi Matthew,

Thanks for your suggestions. Just to clarify, that custom APIs commands are currently not supported or encouraged, which is why there is no developer documentation.


I am 100% behind this.

Unfortunately there are certain circumstances that WHMCS simply doesn't provide support for(some very basic things infact).

However up until now there has been support from developers who have written custom API code to fill the missing functionality, and the suggestion of using a module is insufficient if the documentation is not completely comprehensive(which it is not).

Not sure why this feature was limited in 7.4 without a suitable alternative being provided.

Something as simple as providing a PDF copy of an invoice that was only available via a custom api script has now been broken.

I believe a resolution to this issue should be pushed through asap.

A better way to go about this would have been to phase in the API roles, with support for custom API's and then provided developer documentation on how to convert an API into a hook/module/etc.