Integration Guide

Step-by-step guide to integrate Killbot into your application.

Introduction
With this integration guide, we’ve made it as easy as possible to quickly get up and running with an end-to-end embedded Killbot integration. Please see our Shortlink feature if you're only looking to create unique links to share with your customers.
In this guide, you will:
1.​Integrate Killbot Blocker​
2.​Manage Killbot Blocker​
We recommend reading our Flow Overview for a look at key concepts and a diagram of an end-to-end integration. Integration for other technologies is still in development, but you can integrate them using our REST API.
Killbot blocker has several setting parameters and terms that you need to know as below, please click the link for more information:
1.​Bot Type​
2.​Blocked Type​
3.​Blocked Level​
4.​Firewall​
Integrate Killbot Blocker
In this installation guide, you will install Killbot Blocker in or using:
1.​PHP Web Base Application​
2.​WordPress​
3.​Using Embedded JavaScript​
PHP Web Base Application
Download Killbot-PHP via https://files.killbot.org/Killbot-PHP.zip​
Extract the Killbot-PHP.zip file and the /killbot/ folder will appear.
Upload the /killbot/ folder to the website and put writable permissions on the /killbot/logs/ folder.
Change the /killbot/config.php config for yourself (change the active status, API key, and bot or threats users redirection page). Register to get 3 days free trial period to test the cloud version. Below are the contents of the config.php file that you need to configure.
<?php
​
$CONFIG_KILLBOT = [
 'active' => true, // If 'true' will set blocker protection active, and 'false' will deactive protection
 'apikey' => 'YOUR_APIKEY', // Your API Key from https://killbot.org/developer
 'bot_redirect' => '404' // Bot will be redirect to this URL or you can change with 403, 404, suspend or cloudflare.
];
You can activate and deactivate the protection by setting the parameter 'active'. You need to enter your API Key which was obtained from the Killbot Developer page in the 'apikey' parameter. Then you can set the page or URL that malicious visitors will access in the 'bot_redirection' parameter. The redirection bot variations you can choose from are as follows:
bot_redirection
description
403
Will show 403 Forbidden page.
404
Will show 404 Not Found page.
suspend
Will show suspend page.
cloudflare
Will show fake CloudFlare error page.
{URL}
Will redirect malicious visitors to a specific URL for example you can set to https://google.com.
To the beginning of PHP scripts that need to be protected or to some general script (for example: config.php, function.php, etc.) after <?php add:
require_once($_SERVER['DOCUMENT_ROOT'].'/killbot/code/include.php');
 Connection for different CMS (the path is specified from the root directory of the site):
1.D-zeus (doorway generator) in index.php
2.DataLife Engine (DLE) in index.php
3.Diafan in index.php
4.Drupal in index.php
5.Joomla in index.php
6.MODX in index.php
7.MyBB in inc/config.php
8.OpenCart in index.php
9.PunBB and FluxBB in config.php
10.Webasyst in index.php
11.WordPress in wp-config.php
12.Битрикс in index.php and urlrewrite.php (or only in /bitrix/php_interface/init.php)
For example, we use a simple website using PHP which can be downloaded at https://github.com/banago/simple-php-website, in this example there is a config file located at /includes/config.php 
So that the implementation example will be as below:
<?php
​
/**
 * Used to store website configuration information.
 *
 * @var string or null
 */
​
require_once($_SERVER['DOCUMENT_ROOT'].'/killbot/code/include.php');
​
function config($key = '')
{
 $config = [
 'name' => 'Simple PHP Website',
 'site_url' => '',
 'pretty_uri' => false,
 'nav_menu' => [
 '' => 'Home',
 'about-us' => 'About Us',
 'products' => 'Products',
 'contact' => 'Contact',
 ],
 'template_path' => 'template',
 'content_path' => 'content',
 'version' => 'v3.1',
 ];
​
 return isset($config[$key]) ? $config[$key] : null;
}
​
The installation is complete, you can monitor and make additional settings on the Killbot Blocker page.
WordPress
You who use the WordPress platform don't need to be difficult to integrate Killbot with your website. We have released a plugin that can help you.
Please download Killbot WordPress plugin first in the following link: https://files.killbot.org/Killbot-Blocker-WordPress-Plugin.zip​
Login to your WordPress Dashboard
Go to Plugins > Installed Plugins, then click Add New
Click Upload Plugin then upload plugin which has been downloaded before. After that click Install Now.
After the plugin is installed you still need to activate it, so click the Activate Plugin button.
A new menu will appear, namely the Killbot Blocker menu under the Dashboard menu. Click the menu to enter the API Key and make arrangements.
You need to enter an API Key which you can get at Killbot Developer page. Then there are several settings that need to be entered, such as the URL address that will be accessed by bot visitors, then the IP whitelist and also the status of the plugin is active or not. After entering the API Key and activating the plugin status, Killbot can be used on your WordPress website.
The installation is complete, you can monitor and make additional settings on the Killbot Blocker page.
Using Embedded JavaScript
You can install Killbot Blocker on your website by simply pasting the code below between the HTML code </head></head>
<script type="text/javascript">
 const killbot = {
 apiKey: "YOUR_APIKEY", 
 botRedirection: "REDIRECTION_URL"
 }
</script>
<script src="https://cdn.jsdelivr.net/gh/killbot-org/[email protected]/dist/main.min.js"></script>
The following is an example of its use:
<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>Hello world!</title>
​
 <!-- Killbot Security -->
 <script type="text/javascript">
 const killbot = {
 apiKey: "4OPYxX0xxxxxxxxxxxxxxxx", // Your API Key from https://killbot.org/developer 
 botRedirection: "https://google.com" // Bot will be redirect to this URL
 }
 </script>
 <script src="https://cdn.jsdelivr.net/gh/killbot-org/[email protected]/dist/main.min.js"></script>
 <!-- End Killbot Security -->
</head>
<body>
 <h1>Hello world!</h1>
</body>
</html>
The installation is complete, you can monitor and make additional settings on the Killbot Blocker page.
Manage Killbot Blocker
Open the Killbot Blocker page.
The following is information about the forms in the Killbot Blocker feature which can be used to manage Blocker:
From
Description
Device
Choose any device that can enter the destination domain.
Blocked Type
Choose any visitors who are allowed to enter the destination domain. The rest can be read on the Blocked Type page.
Blocked Level
Select the security level to keep out bad users. The rest can be read on the Blocked Level page.
Country
Which countries can access the designated domain. You can customize it via the Customize Bot Redirection page.
Firewall
Select ON to activate WAF. The rest can be read on the Firewall page.

bot_redirection	description
403	Will show 403 Forbidden page.
404	Will show 404 Not Found page.
suspend	Will show suspend page.
cloudflare	Will show fake CloudFlare error page.
{URL}	Will redirect malicious visitors to a specific URL for example you can set to https://google.com.

From	Description
Device	Choose any device that can enter the destination domain.
Blocked Type	Choose any visitors who are allowed to enter the destination domain. The rest can be read on the Blocked Type page.
Blocked Level	Select the security level to keep out bad users. The rest can be read on the Blocked Level page.
Country	Which countries can access the designated domain. You can customize it via the Customize Bot Redirection page.
Firewall	Select ON to activate WAF. The rest can be read on the Firewall page.

Next - Integration

API Reference

Last modified 5mo ago