This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
amp:amp_api [2020/03/18 09:41] rsk [Example PHP Curl Script] |
amp:amp_api [2020/03/25 12:30] (current) rsk [Abuse Manager Pro API] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Abuse Manager Pro API ====== | ====== Abuse Manager Pro API ====== | ||
- | <color # | + | <color # |
This page explains the ways to interact with the Abuse Manager Pro API. | This page explains the ways to interact with the Abuse Manager Pro API. | ||
Line 12: | Line 12: | ||
* Click on API credentials, | * Click on API credentials, | ||
* Copy the identifier only - we do not need the secret | * Copy the identifier only - we do not need the secret | ||
- | * This identifier will be the API Key needed | + | * This identifier will be the API_ID that needs to be passed in the header of your call to authenticate with the API |
+ | <code php>' | ||
===== API URL / Endpoint ===== | ===== API URL / Endpoint ===== | ||
Line 25: | Line 26: | ||
- | ===== Error Codes ===== | ||
- | ^ Code ^ Description | ||
- | | AMP001 | ||
- | | AMP002 | ||
- | | AMP003 | ||
- | | AMP004 | ||
---- | ---- | ||
Line 47: | Line 42: | ||
| service_id | required - this is the WHMCS ID of the service that the abuse report will be created for | | | service_id | required - this is the WHMCS ID of the service that the abuse report will be created for | | ||
| category | required - this is the category of abuse - can be any value e.g. ' | | category | required - this is the category of abuse - can be any value e.g. ' | ||
- | | service_ip | optional - if not passed | + | | service_ip | optional - if not passed, the main dedicated IP of the service will be used - if service doesn' |
| suspend_method | optional - defaults to nosuspend - available options are ' | | suspend_method | optional - defaults to nosuspend - available options are ' | ||
| allow_unsuspend | optional - defaults to false - if you want to give the customer the option to self unsuspend set to true | | | allow_unsuspend | optional - defaults to false - if you want to give the customer the option to self unsuspend set to true | | ||
Line 57: | Line 52: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Error Codes ===== | ||
+ | |||
+ | ^ Code ^ Description | ||
+ | | AMP001 | ||
+ | | AMP002 | ||
+ | | AMP003 | ||
---- | ---- | ||
Line 77: | Line 81: | ||
' | ' | ||
| | ||
- | ' | + | ' |
' | ' | ||
' | ' |