README

A modern, powerful, and fully-featured PHP client for SIGUR Public REST API v1.6.7.60.
Современный и полнофункциональный PHP-клиент для SIGUR Public REST API v1.6.7.60.

🌍 Contents / Оглавление

• English Version
• Русская версия

English Version

🌟 Features

• Full employee management
• Card operations (UID, W26, W34, W37, W58, W58DEC)
• Access rules, zones, access points
• Raw and parsed events
• Guest creation (cards, QR codes)
• Batch operations
• Auto token refresh
• Clean & intuitive PHP API

📦 Installation

composer require basiliy-wolf/sigur-api-client

Requirements

• PHP >= 7.4
• cURL extension
• JSON extension

🚀 Quick Start

use SigurApi\SigurApiClient;

$client = new SigurApiClient(
    'http://192.168.0.108:9500',
    'username',
    'password'
);

$client->testConnection();
$departments = $client->getDepartments(['limit' => 10]);

📘 API Methods Overview

Employees

Cards

Access Control

Events

Guests

System

📝 Usage Examples

Create employee with card

$employee = $client->createEmployee([
    'name' => 'John Smith',
    'departmentId' => 1,
    'positionId' => 2,
    'tabId' => 'EMP001'
]);

$card = $client->createCard([
    'value' => 'AABBCCDDEEFF',
    'format' => 'W26'
]);

$client->assignCardsToEmployees([[
    'employeeId' => $employee['id'],
    'cardId' => $card['id'],
    'format' => 'W26'
]]);

❗ Error Handling

try {
    $client->getEmployee(999999);
} catch (SigurApiException $e) {
    echo "Error: {$e->getMessage()}";
}

🧪 Testing

composer test

🔒 Security

• Auto-refresh tokens
• TLS support
• Input validation

🤝 Contributing

Pull requests are welcome!

📄 License

MIT License

Russian Version

🌟 Возможности

• Управление сотрудниками
• Операции с картами (UID, W26, W34, W37, W58 и др.)
• Правила доступа, зоны, точки
• Сырые и разобранные события
• Гости (карты, QR-коды)
• Пакетные операции
• Автоматическое обновление токена
• Удобный PHP-интерфейс

📦 Установка

composer require basiliy-wolf/sigur-api-client

Требования

• PHP >= 7.4
• cURL, JSON

🚀 Быстрый старт

$client = new SigurApiClient(
    'http://192.168.0.108:9500',
    'login',
    'password'
);

$client->testConnection();
$departments = $client->getDepartments(['limit' => 10]);

📘 Обзор методов API

Сотрудники

Карты

Контроль доступа

События

Гости

Система

📝 Примеры

$employee = $client->createEmployee([
    'name' => 'Иван Иванов',
    'departmentId' => 1
]);

$card = $client->createCard([
    'value' => 'AABBCCDDEEFF',
    'format' => 'W26'
]);

$client->assignCardsToEmployees([[
    'employeeId' => $employee['id'],
    'cardId' => $card['id']
]]);

❗ Обработка ошибок

try {
    $client->getEmployee(999999);
} catch (SigurApiException $e) {
    echo "Ошибка: {$e->getMessage()}";
}

🧪 Тестирование

composer test

🔒 Безопасность

• Автообновление токенов
• TLS
• Валидация

🤝 Вклад

Pull Request’ы приветствуются!

📄 Лицензия

MIT