Download the PHP package gregorybiter/roapp-sdk without Composer
On this page you can find all versions of the php package gregorybiter/roapp-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package roapp-sdk
Roapp-PHP-SDK 🚀
PHP SDK для работы с Roapp CRM API — современной системой управления сервисными центрами и ремонтами.
📦 Установка
Требования:
- PHP >= 7.4
- Расширение cURL
- Расширение JSON
⚠️ ВАЖНО: Модули (Models)
[!WARNING] На данный момент не рекомендуется использовать высокоуровневые модули из пространства имен
Gbit\Roapp\Models(такие какOrder,People,Productи т.д.). Они находятся в стадии активной переработки под новую структуру API (V2).Рекомендуемый способ взаимодействия — использование универсальных методов класса
RoappClient.
🔑 Аутентификация
SDK использует Bearer Token. Получите ваш API ключ в личном кабинете Roapp: Настройки > API.
⚡ Быстрый старт (Рекомендуемый подход)
Используйте методы getData, request и requestWithRetry для прямого взаимодействия с эндпоинтами.
📥 Получение данных (с авто-пагинацией)
Метод getData позволяет автоматически собрать данные со всех страниц, если это необходимо.
📤 Создание и обновление данных
🔄 Продвинутые запросы
🔁 Автоматические повторы (Retry)
Если API возвращает ошибку 429 (Too Many Requests), метод requestWithRetry автоматически подождет и повторит запрос.
🛠️ Низкоуровневый доступ (Класс Api)
Если вам нужен полный контроль над cURL или вы хотите использовать SDK без обертки RoappClient:
🔥 Обработка ошибок
SDK предоставляет информативное исключение RoappApiException, которое содержит детали ответа сервера.
📝 Логирование
По умолчанию ошибки логируются в файл logs/error.log. Вы можете добавлять свои записи:
📖 Справочник эндпоинтов (V2)
Основные маршруты API V2 (рекомендуются к использованию):
| Сущность | Эндпоинт |
|---|---|
| Заказы | v2/orders |
| Финансы | v2/finance |
| Счета | v2/finance/accounts |
| Клиенты | v2/people |
| Товары | v2/products |
Полный список доступен в Официальной документации Roapp API.
🤝 Поддержка и разработка
- Issues: GitHub Issues
- Maintainer: GregoryBiter ([email protected])
📄 Лицензия
Проект распространяется под лицензией MIT.