API

The API is an interface to allow you to access and perform actions inside WHMCS from external applications and scripts. It allows you to furthur automate and integrate your WHMCS system with other processes you have.

API User Setup

When creating an admin user for API use, only the API permission is required to be able to access & use all the API functions.

You must also setup the IP(s) you will be connecting from in General Settings > Security. Failure to do this will result in an Invalid IP response from the API.

Example Code

We have PHP code samples demonstrating how you can connect to and interpret each of the supported response types from the WHMCS API here:

• Sample NVP Code
• Sample XML Code

Need something else?

The API is being continually developed and added to as features are requested. If you have a need for a feature that is not currently available, feel free to contact us and let us know and we'll see what we can do.