Core Endpoints - supportpal/api-client-php GitHub Wiki

Below are the currently supported core endpoints.

Brands

GET /core/brand

$brands = $api->getCoreApi()->getBrands();

You can filter the results as shown below. For a full list of supported filtering options, see https://api.supportpal.com/api.html#core-brand-get

$brands = $api->getCoreApi()->getBrands(['enabled' => 1]);

GET /core/brand/{id}

$brand = $api->getCoreApi()->getBrand($id);

General Settings

GET /core/settings

$settings = $api->getCoreApi()->getSettings();

IP Bans

GET /core/ipban

$ips = $api->getCoreApi()->getIpBans();

You can filter the results as shown below. For a full list of supported filtering options, see https://api.supportpal.com/api.html#core-ip-ban-get

$ips = $api->getCoreApi()->getIpBans(['type' => 1]);

GET /core/ipban/{id}

$ip = $api->getCoreApi()->getIpBan($id);

POST /core/ipban

$createIpBan = new \SupportPal\ApiClient\Model\Core\Request\CreateIpBan(['ip' => '123.1.3.4', 'type' => 1]);
$api->getCoreApi()->createIpBan($createIpBan);

For a full list of parameters, see https://api.supportpal.com/api.html#core-ip-ban-post

PUT /core/ipban/{id}

$updateIpBan = new \SupportPal\ApiClient\Model\Core\Request\UpdateIpBan(['ip' => '123.1.3.4', 'type' => 1]);
$api->getCoreApi()->updateIpBan($id, $updateIpBan);

For a full list of parameters, see https://api.supportpal.com/api.html#core-ip-ban-put

DELETE /core/ipban/{id}

$api->getCoreApi()->deleteIpBan($id);

IP Whitelist

GET /core/ipwhitelist

$ips = $api->getCoreApi()->getWhitelistedIps();

You can filter the results as shown below. For a full list of supported filtering options, see https://api.supportpal.com/api.html#core-ip-whitelist-get

$ips = $api->getCoreApi()->getWhitelistedIps(['ip' => '23.123.12.3']);

GET /core/ipwhitelist/{id}

$ip = $api->getCoreApi()->getWhitelistedIp($id);

POST /core/ipwhitelist

$createWhitelistedIp = new \SupportPal\ApiClient\Model\Core\Request\CreateWhitelistedIp(['ip' => '123.1.3.4']);
$api->getCoreApi()->createWhitelistedIp($createWhitelistedIp);

For a full list of parameters, see https://api.supportpal.com/api.html#core-ip-whitelist-post

PUT /core/ipwhitelist/{id}

$updateWhitelistedIp = new \SupportPal\ApiClient\Model\Core\Request\UpdateWhitelistedIp(['event_operator' => 1]);
$api->getCoreApi()->updateWhitelistedIp($id, $updateWhitelistedIp);

For a full list of parameters, see https://api.supportpal.com/api.html#core-ip-whitelist-put

DELETE /core/ipwhitelist/{id}

$api->getCoreApi()->deleteWhitelistedIp($id);

Languages

GET /core/language

$languages = $api->getCoreApi()->getLanguages();

You can filter the results as shown below. For a full list of supported filtering options, see https://api.supportpal.com/api.html#core-language-get

$languages = $api->getCoreApi()->getLanguages(['enabled' => 0]);

Spam Rules

GET /core/spamrule

$rules = $api->getCoreApi()->getSpamRules();

For a full list of supported filtering options, see https://api.supportpal.com/api.html#core-spam-rules-get

GET /core/spamrule/{id}

$rule = $api->getCoreApi()->getSpamRule($id);

POST /core/spamrule

$createSpamRule = new \SupportPal\ApiClient\Model\Core\Request\CreateSpamRule(['text' => 'spam rule text', 'type' => 0]);
$api->getCoreApi()->createSpamRule($createSpamRule);

For a full list of parameters, see https://api.supportpal.com/api.html#core-spam-rules-post

PUT /core/spamrule/{id}

$updateSpamRule = new \SupportPal\ApiClient\Model\Core\Request\UpdateSpamRule(['type' => 1]);
$api->getCoreApi()->updateSpamRule($id, $updateSpamRule);

For a full list of parameters, see https://api.supportpal.com/api.html#core-spam-rules-put

DELETE /core/spamrule/{id}

$api->getCoreApi()->deleteSpamRule($id);