> For the complete documentation index, see [llms.txt](https://docs.stopbot.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stopbot.net/main/introduction.md).

# Introduction

STOPBOT helps websites and applications identify suspicious traffic, reduce bot activity, and make safer access decisions before visitors reach protected content.

It is designed for teams that need practical protection against automated traffic, abusive requests, fake visitors, risky IP addresses, suspicious user agents, and unwanted access patterns. STOPBOT can be used on landing pages, login pages, checkout pages, shortlinks, dashboards, admin pages, and other sensitive entry points.

### What STOPBOT Does

STOPBOT receives visitor context from your website or application, analyzes the request, and returns a result that your system can apply immediately.

Depending on the service you use, STOPBOT can:

* allow legitimate visitors to continue
* block suspicious visitors
* redirect traffic based on your rules
* return a custom page response
* verify browser activity with JavaScript
* identify IP address details
* validate email addresses
* identify phone number information
* display traffic activity and reports in the STOPBOT panel

### Core Services

| Service               | Purpose                                                                   |
| --------------------- | ------------------------------------------------------------------------- |
| Blocker               | Detect suspicious visitors and return an allow or block decision          |
| Blocker V2            | Apply advanced protection rules with custom page responses                |
| SmartURLs             | Protect and manage shortlink traffic with redirect and verification logic |
| IP Lookup             | Get IP geolocation, ISP, ASN, hostname, and network information           |
| Email Validation      | Check email format, domain, MX, SPF, DMARC, and disposable email status   |
| Phone Number Identify | Validate and identify phone number type, carrier, country, and location   |
| Account               | Review account package, quota, usage, and expiration status               |

### How It Works

The basic workflow is simple:

```
Visitor reaches your website
  ->
Your server sends visitor context to STOPBOT
  ->
STOPBOT validates and analyzes the request
  ->
STOPBOT returns a decision or lookup result
  ->
Your website applies the result
  ->
Activity can be reviewed in the STOPBOT panel
```

STOPBOT should be integrated from your server side whenever an API key is required. Do not expose your API key in public frontend JavaScript, mobile app bundles, or public repositories.

### Who This Documentation Is For

This documentation is intended for:

* developers integrating STOPBOT into websites or applications
* security teams reviewing visitor protection workflows
* product teams using SmartURLs and traffic reports
* support teams helping customers configure STOPBOT services
* technical users who need clear API examples and service behavior

### Recommended Starting Points

If you are new to STOPBOT, start with:

| Page                   | Use It For                                      |
| ---------------------- | ----------------------------------------------- |
| Workflow Overview      | Understand the full protection flow             |
| Getting Started        | Learn the basic integration steps               |
| Authentication & Quota | Understand API key usage, quota, and expiration |
| Blocker                | Add a simple traffic protection decision        |
| SmartURLs              | Protect and control shortlink traffic           |
| Blocker V2             | Use advanced rules and custom page responses    |
| Error Codes            | Handle failed or invalid requests correctly     |

### Production Checklist

Before using STOPBOT on a live website, confirm that:

* your API key is active
* your API key is stored only on the server side
* your account has available quota
* visitor IP forwarding is correct behind Cloudflare or a reverse proxy
* your SmartURLs keynames are registered
* your Blocker V2 configuration names are registered
* allow, block, redirect, and page response behavior has been tested
* traffic logs and reports appear in the STOPBOT panel

### Next Step

Continue to the Workflow Overview to understand how STOPBOT processes visitors and returns decisions to your website.
