Difference between revisions of "API"
| Line 1: | Line 1: | ||
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. | 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 a sample demonstrating how you can connect to and interpret the responses from the WHMCS API using the name/value pairs response method here: [[API:Example_Usage|Example PHP Code]] | ||
| + | |||
| + | ==Functions== | ||
| + | |||
| + | {{:API:Functions}} | ||
| − | + | ==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. | |
Revision as of 13:32, 21 November 2010
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 a sample demonstrating how you can connect to and interpret the responses from the WHMCS API using the name/value pairs response method here: Example PHP Code
Functions
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.