ساخت API برای شمارش و مدیریت بازدیدها با PHP

در دنیای وب امروزی، ردیابی و تحلیل بازدیدها از اهمیت بالایی برخوردار است. این اطلاعات به صاحبان وب‌سایت‌ها کمک می‌کند تا درک بهتری از رفتار کاربران خود داشته باشند، اثربخشی کمپین‌های بازاریابی را ارزیابی کنند و تصمیمات آگاهانه‌تری برای بهبود محتوا و تجربه کاربری بگیرند. یکی از روش‌های موثر برای جمع‌آوری و مدیریت این اطلاعات، استفاده از API (Application Programming Interface) است. این مقاله به بررسی نحوه ساخت یک API ساده و کاربردی برای شمارش و مدیریت بازدیدها با استفاده از زبان PHP می‌پردازد.

مقدمه

API به عنوان یک واسط ارتباطی بین دو سیستم نرم‌افزاری عمل می‌کند. در این مورد، API ما به عنوان یک نقطه پایانی (Endpoint) عمل خواهد کرد که درخواست‌های مربوط به شمارش و بازیابی اطلاعات بازدیدها را دریافت و پاسخ می‌دهد. استفاده از API به ما امکان می‌دهد تا اطلاعات بازدیدها را به راحتی در سیستم‌های مختلف (مانند پنل‌های مدیریتی، ابزارهای تحلیل داده و غیره) یکپارچه کنیم.

پیش‌نیازها

برای شروع، به موارد زیر نیاز دارید:

• یک سرور وب با PHP فعال (مانند Apache یا Nginx)
• یک پایگاه داده (مانند MySQL یا PostgreSQL)
• دانش پایه PHP و SQL

طراحی پایگاه داده

برای ذخیره اطلاعات بازدیدها، یک جدول ساده در پایگاه داده ایجاد می‌کنیم. این جدول شامل ستون‌های زیر خواهد بود:

• id: شناسه یکتا برای هر بازدید (auto-increment)
• page_url: آدرس صفحه‌ای که بازدیدکننده از آن بازدید کرده است.
• ip_address: آدرس IP بازدیدکننده.
• user_agent: رشته User Agent مرورگر بازدیدکننده.
• timestamp: زمان بازدید.

کد SQL برای ایجاد جدول:

CREATE TABLE visits (
    id INT AUTO_INCREMENT PRIMARY KEY,
    page_url VARCHAR(255) NOT NULL,
    ip_address VARCHAR(45) NOT NULL,
    user_agent TEXT,
    timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

ساخت API با PHP

اکنون به ساخت API با استفاده از PHP می‌پردازیم. ما از یک رویکرد ساده و مستقیم استفاده خواهیم کرد. ابتدا، یک فایل PHP ایجاد می‌کنیم (مثلاً api.php) و کد زیر را در آن قرار می‌دهیم:

connect_error) {
    die("Connection failed: " . $conn->connect_error);
}

// تنظیم هدر برای پاسخ JSON
header('Content-Type: application/json');

// دریافت متد درخواست (GET, POST, PUT, DELETE)
$method = $_SERVER['REQUEST_METHOD'];

// مسیر درخواست
$path = $_SERVER['REQUEST_URI'];

// تجزیه مسیر برای تعیین Endpoint
$parts = explode('/', trim($path, '/'));

// Endpoint های API
switch ($method) {
    case 'POST':
        // ثبت بازدید
        if ($parts[0] == 'visits') {
            $page_url = $_POST['page_url'] ?? '';
            $ip_address = $_SERVER['REMOTE_ADDR'];
            $user_agent = $_SERVER['HTTP_USER_AGENT'];

            $sql = "INSERT INTO visits (page_url, ip_address, user_agent) VALUES ('$page_url', '$ip_address', '$user_agent')";

            if ($conn->query($sql) === TRUE) {
                echo json_encode(['status' => 'success', 'message' => 'Visit recorded']);
            } else {
                echo json_encode(['status' => 'error', 'message' => 'Error recording visit: ' . $conn->error]);
            }
        } else {
            http_response_code(404);
            echo json_encode(['status' => 'error', 'message' => 'Endpoint not found']);
        }
        break;

    case 'GET':
        // دریافت تعداد بازدیدها
        if ($parts[0] == 'visits' && $parts[1] == 'count') {
            $page_url = $_GET['page_url'] ?? '';

            $sql = "SELECT COUNT(*) AS count FROM visits WHERE page_url = '$page_url'";
            $result = $conn->query($sql);

            if ($result->num_rows > 0) {
                $row = $result->fetch_assoc();
                echo json_encode(['status' => 'success', 'count' => $row['count']]);
            } else {
                echo json_encode(['status' => 'error', 'message' => 'No data found']);
            }
        }
        // دریافت لیست بازدیدها
        elseif ($parts[0] == 'visits') {
            $sql = "SELECT * FROM visits";
            $result = $conn->query($sql);

            $visits = [];
            if ($result->num_rows > 0) {
                while($row = $result->fetch_assoc()) {
                    $visits[] = $row;
                }
                echo json_encode(['status' => 'success', 'visits' => $visits]);
            } else {
                echo json_encode(['status' => 'error', 'message' => 'No data found']);
            }
        }
        else {
            http_response_code(404);
            echo json_encode(['status' => 'error', 'message' => 'Endpoint not found']);
        }
        break;

    default:
        http_response_code(405);
        echo json_encode(['status' => 'error', 'message' => 'Method not allowed']);
}

// بستن اتصال
$conn->close();
?>

توضیحات کد

کد بالا شامل مراحل زیر است:

• اتصال به پایگاه داده با استفاده از اطلاعات اتصال.
• تنظیم هدر پاسخ به application/json برای ارسال داده‌ها به صورت JSON.
• دریافت متد درخواست (GET، POST، PUT، DELETE) و مسیر درخواست.
• استفاده از یک ساختار switch برای تعیین Endpoint مورد نظر و اجرای کد مربوطه.
• Endpoint /visits با متد POST: برای ثبت بازدید جدید در پایگاه داده.
• Endpoint /visits/count با متد GET: برای دریافت تعداد بازدیدهای یک صفحه خاص.
• Endpoint /visits با متد GET: برای دریافت لیست تمام بازدیدها.
• بررسی خطاها و ارسال پاسخ مناسب به صورت JSON.
• بستن اتصال به پایگاه داده.

نحوه استفاده از API

برای استفاده از API، می‌توانید از ابزارهایی مانند curl، Postman یا زبان‌های برنامه‌نویسی دیگر استفاده کنید. در اینجا چند مثال آورده شده است:

ثبت بازدید (POST)

برای ثبت بازدید یک صفحه، یک درخواست POST به Endpoint /visits ارسال کنید. پارامتر page_url را در بدنه درخواست (body) قرار دهید.

curl -X POST -d "page_url=https://example.com/page1" http://your-server/api.php

دریافت تعداد بازدیدها (GET)

برای دریافت تعداد بازدیدهای یک صفحه، یک درخواست GET به Endpoint /visits/count ارسال کنید. پارامتر page_url را به عنوان پارامتر query string اضافه کنید.

curl "http://your-server/api.php?page_url=https://example.com/page1"

دریافت لیست بازدیدها (GET)

برای دریافت لیست تمام بازدیدها، یک درخواست GET به Endpoint /visits ارسال کنید.

curl "http://your-server/api.php"

بهبود و گسترش API

API ساخته شده در این مقاله یک نمونه ساده است و می‌توان آن را به روش‌های مختلف بهبود و گسترش داد. برخی از ایده‌ها عبارتند از:

• اضافه کردن اعتبارسنجی ورودی‌ها برای جلوگیری از حملات تزریقی SQL.
• پیاده‌سازی سیستم احراز هویت برای محدود کردن دسترسی به API.
• اضافه کردن قابلیت فیلتر کردن و مرتب‌سازی داده‌ها.
• استفاده از یک فریم‌ورک PHP (مانند Laravel یا Symfony) برای ساخت API پیچیده‌تر.
• پیاده‌سازی caching برای بهبود عملکرد API.
• استفاده از یک سیستم لاگینگ برای ثبت خطاها و رویدادها.

نتیجه‌گیری

در این مقاله، نحوه ساخت یک API ساده و کاربردی برای شمارش و مدیریت بازدیدها با استفاده از PHP را بررسی کردیم. این API به شما امکان می‌دهد تا اطلاعات بازدیدها را به راحتی جمع‌آوری، ذخیره و بازیابی کنید. با استفاده از این API، می‌توانید درک بهتری از رفتار کاربران خود داشته باشید و تصمیمات آگاهانه‌تری برای بهبود وب‌سایت خود بگیرید. با توجه به نیازهای خود، می‌توانید این API را بهبود و گسترش دهید تا قابلیت‌های بیشتری را ارائه دهد.