| Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
amp:amp_api [2020/03/17 14:34]
rsk [Abuse Manager Pro API] |
amp:amp_api [2020/03/25 12:30] (current)
rsk [Abuse Manager Pro API] |
| ====== Abuse Manager Pro API ====== | ====== Abuse Manager Pro API ====== |
| |
| <color #ffc90e>__The API is not released yet. It will be part of v3.4's release.__</color> | <color #ffc90e>__The API has been introduced in v3.4. Therefore, it is only available & supported on v3.4 and above.__</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. |
| * Click on API credentials, click on Generate New API Credential button, select your admin user, select the API role created previously | * Click on API credentials, click on Generate New API Credential button, select your admin user, select the API role created previously |
| * 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 to authenticate with the API | * 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_ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'</code> |
| ===== API URL / Endpoint ===== | ===== API URL / Endpoint ===== |
| |
| |
| |
| ===== Error Codes ===== | |
| |
| ^ Code ^ Description ^ | |
| | AMP001 | TBD | | |
| | AMP002 | TBD | | |
| | AMP003 | TBD | | |
| | AMP004 | TBD | | |
| |
| ---- | ---- |
| ^ HTTP Method | POST | | ^ HTTP Method | POST | |
| ^ Authentication Required | Yes | | ^ Authentication Required | Yes | |
| ^ Variables | <WRAP><code> | ^ Variables | <WRAP> |
| * 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. 'Spam' or 'High I/O' or 'Hacking Attempts' etc.) | | category | required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc. | |
| * service_ip (optional - if not passed X) | | service_ip | optional - if not passed, the main dedicated IP of the service will be used - if service doesn't have a dedicated IP it will default to (No Dedicated IP) | |
| * suspend_method (optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit') | | suspend_method | optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit' | |
| * 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 | |
| * additional_info (optional - This is the additional information field - this is visible to the customer) | | additional_info | optional - This is the additional information field - this is visible to the customer | |
| * admin_notes (optional - This is the admin notes field - this is only visible to the admins) | | admin_notes | optional - This is the admin notes field - this is only visible to the admins | |
| </code></WRAP>| | </WRAP>| |
| ^ Success JSON Output | <code javascript>"{"status":"success","report_id":92}"</code> | | ^ Success JSON Output | <code javascript>"{"status":"success","report_id":92}"</code> | |
| ^ Error JSON Output | <code javascript>"{"status":"error","error_code":"AMP009","error_description":"Missing required parameters."}"</code> | | ^ Error JSON Output | <code javascript>"{"status":"error","error_code":"AMP009","error_description":"Missing required parameters."}"</code> | |
| |
| |
| | |
| | ---- |
| | |
| | ===== Error Codes ===== |
| | |
| | ^ Code ^ Description ^ |
| | | AMP001 | Unauthorized - make sure you are passing a valid API_ID in the header | |
| | | AMP002 | Missing or Invalid Action - make sure you are passing a valid action | |
| | | AMP003 | Missing required parameters - make sure you are passing the required parameters for the action | |
| |
| ---- | ---- |
| ===== Example PHP Curl Script ===== | ===== Example PHP Curl Script ===== |
| |
| The example shows how to integrate Clickatell's API using the Custom Dev Kit. | The example below shows how to create an abuse report programmatically using the API service. |
| |
| <file php example-php-curl.php> | <file php example-php-curl.php> |
| 'category' => 'Spam', // required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc. | 'category' => 'Spam', // required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc. |
| | |
| 'service_ip' => '1.2.3.4', // optional - if not passed X | 'service_ip' => '1.2.3.4', // optional - if not passed, the main dedicated IP of the service will be used - if service doesn't have a dedicated IP it will default to (No Dedicated IP) |
| 'suspend_method' => 'suspend', // optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit' | 'suspend_method' => 'suspend', // optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit' |
| 'allow_unsuspend' => true, // optional - defaults to false - if you want to give the customer the option to self unsuspend set to true | 'allow_unsuspend' => true, // optional - defaults to false - if you want to give the customer the option to self unsuspend set to true |
