مقدمه

به PHP SDK باسلام خوش آمدید - یک کتابخانه جامع برای تعامل با APIهای سرویس‌های باسلام. این SDK رابطی ساده، تمیز و توسعه‌دهنده‌پسند برای تمام سرویس‌های باسلام فراهم می‌کند. این PHP SDK طراحی شده تا ادغام با سرویس‌های باسلام را تا حد ممکن ساده و کارآمد کند. چه در حال ساخت یک ارتباط سرور به سرور باشید و چه در حال توسعه‌ یک اپلیکیشن کاربرمحور، این SDK ابزارهای مورد نیاز شما را فراهم می‌کند.

نسخه‌های PHP پشتیبانی شده: PHP 8.0+, PHP 8.1+, PHP 8.2+, PHP 8.3+

ویژگی‌های کلیدی:

• پوشش جامع سرویس‌ها: دسترسی به تمام سرویس‌های باسلام شامل کیف پول، سفارش‌ها، گفت‌وگو و موارد دیگر
• روش‌های مختلف احراز هویت: پشتیبانی از گواهی‌نامه‌های کاربر (Client Credentials)، جریان کد مجوز (Authorization Code Flow) و توکن‌های دسترسی شخصی (PAT)
• تضمین نوع داده‌ها: استفاده از Type Hints و Validation برای بررسی و اعتبارسنجی دقیق نوع داده‌ها
• مدیریت خطا: کلاس‌های خطای دقیق برای انواع مختلف خطاها
• مناسب برای توسعه‌دهندگان: طراحی ساده و استاندارد API به‌همراه مستندات کامل و جامع

فهرست مطالب

• نصب
• شروع سریع
• روش‌های احراز هویت
• نمای کلی سرویس‌ها

نصب

SDK را با استفاده از Composer نصب کنید:

composer require basalam/php-sdk

شروع سریع

۱. تنظیم احراز هویت

<?php
 
require_once 'vendor/autoload.php';
 
use Basalam\SDK\BasalamClient;
use Basalam\SDK\Auth\PersonalToken;
 
// توکن دسترسی شخصی (PAT)
$auth = new PersonalToken(
    token: 'your-access-token',
    refreshToken: 'your-refresh-token'
);
 
// ایجاد کلاینت
$client = new BasalamClient($auth);

۲. اولین فراخوانی‌های API شما

دریافت محصولات

// دریافت محصولات
$products = $client->getProducts();
echo "Found " . count($products) . " products\n";

ارسال پیام و دریافت گفت‌وگوها

// ایجاد یک پیام
use Basalam\SDK\Chat\Models\MessageRequest;
use Basalam\SDK\Chat\Enums\MessageTypeEnum;
 
$message = $client->createMessage(
    new MessageRequest(
        chatId: 123,
        content: 'سلام، چطور می‌توانم کمکتان کنم؟',
        messageType: MessageTypeEnum::TEXT
    )
);
 
// دریافت پیام‌ها از یک گفت‌وگو
$messages = $client->getMessages(
    chatId: 123,
    limit: 20,
    order: 'DESC'
);

نمای کلی سرویس‌ها

در PHP SDK باسلام از تمامی ریسورس‌های سرویس‌های زیر به صورت یکپارچه‌سازی‌شده پشتیبانی شده است:

• سرویس مرکزی (کاربر، غرفه و محصول) - غرفه‌داران، محصولات، روش‌های ارسال و اطلاعات کاربر
• سرویس سفارش - مدیریت سبد خرید، پرداخت‌ها و فاکتورها
• سرویس رهگیری سفارش - سفارشات مشتری و غرفه‌داران
• سرویس کیف پول - مدیریت موجودی‌ها، هزینه‌ها و بازپرداخت‌های کاربر
• سرویس گفت‌وگو - عملکردهای پیام‌رسانی و چت باسلام
• سرویس آپلود - آپلود فایل
• سرویس سرچ - جست‌وجوی محصول
• سرویس وب‌هوک - مدیریت رخدادها و وب‌هوک