Download the PHP package wearesho-team/risktools-blacklist without Composer
On this page you can find all versions of the php package wearesho-team/risktools-blacklist. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wearesho-team/risktools-blacklist
More information about wearesho-team/risktools-blacklist
Files in wearesho-team/risktools-blacklist
Package risktools-blacklist
Short Description RiskTools Blacklist Integration
License MIT
Informations about the package risktools-blacklist
RiskTools Blacklist SDK
Реалізація SDK для API RiskTools Blacklist.
Сервіс дозволяє перевіряти позичальників на наявність у чорних списках за допомогою API. Чорні списки передаються кредиторами. Кожен запис містить категорію (причину), за якою клієнт доданий до чорного списку.
Зміст
- Встановлення
- Конфігурація
- Базова конфігурація
- Конфігурація через змінні оточення
- Ініціалізація сервісу
- Використання Builder
- Використання Dependency Injection
- Пошук
- Формування запиту
- Доступні категорії
- Отримання результатів
- Оновлення (додавання) даних
- Формування записів
- Відправка даних
- Обробка відповіді
- Обробка винятків
- Exception
- RequestException
- ResponseException
- CLI Утиліта
- Встановлення
- Використання
- Опції команди
- Приклад виводу
- Ліцензія
Встановлення
Конфігурація
Для налаштування пакету доступні два варіанти конфігурації, які реалізують інтерфейс ConfigInterface:
Базова конфігурація
Використовуйте клас Config для прямого налаштування через конструктор:
Конфігурація через змінні оточення
Клас EnvironmentConfig
дозволяє налаштувати пакет використовуючи змінні оточення:
Змінна оточення | Опис |
---|---|
RISK_TOOLS_BLACKLIST_AUTH_KEY | Ключ авторизації для доступу до API |
RISK_TOOLS_BLACKLIST_API_URL | URL-адреса API сервісу |
Приклад використання:
Для цього варіанту необхідно попередньо налаштувати відповідні змінні оточення у вашому середовищі або .env файлі:
Ініціалізація сервісу
Використання Builder
Для створення екземпляра сервісу використовуйте Builder:
Налаштування за замовчуванням
За замовчуванням Builder використовує:
- EnvironmentConfig - конфігурація з змінних оточення
- GuzzleHttp\Client - стандартний HTTP-клієнт
Використання Dependency Injection
Для використання сервісу з Dependency Injection вам необхідно налаштувати DI Container для реалізації двох інтерфейсів:
- ConfigInterface
- \GuzzleHttp\ClientInterface
Пошук
Для виконання пошуку у чорному списку використовуйте метод search() сервісу. Пошук можливий за номером телефону та/або ІПН. Якщо в параметрах пошуку задані одночасно і ІПН та номер телефону, пошук виконуйтеся за логікою АБО, тобто будуть знайдені записи, у яких збігається ІПН або номер телефону.
Доступні категорії
Для фільтрації записів доступні наступні категорії (Category enum):
MILITARY
- військовийCLAIM
- скарга НБУFRAUD
- шахрайствоCIRCLE
- на прохання близьких осіб (батьки тощо)DEAD
- померGAMING
- лудоманINCAPABLE
- недієздатнийWRITEOFF
- списанняINADEQUATE
- неадекватна поведінкаADDICT
- залежність (алгоголізм, наркоманія тощо)LOST_DOCS
- втрачені документиSELF
- за власним бажаннямOTHER
- інше
Формування запиту
Отримання результатів
Оновлення (додавання) даних
Формування записів
Відправка даних
Обробка відповіді
Обробка винятків
SDK використовує три типи винятків для різних ситуацій:
Exception
Базовий інтерфейс для всіх винятків SDK. Рекомендується використовувати його для відлову будь-яких помилок SDK:
RequestException
Виникає у випадках:
- Мережевих помилок
- Невірного формату відповіді API
- Помилок автентифікації
- Інших помилок HTTP-запитів
ResponseException
Виникає при некоректному форматі даних у відповіді API:
- Відсутні обов'язкові поля
- Неправильні типи даних
- Неможливість обробки відповіді
CLI Утиліта
SDK містить консольну утиліту для пошуку даних в чорному списку.
Встановлення
Після встановлення пакету через composer, утиліта буде доступна як vendor/bin/blacklist
.
Використання
Опції команди
-phone, -p
: Номер телефону для пошуку-ipn, -i
: ІПН для пошуку-category, -c
: Категорія для фільтрації (за замовчуванням: other)-v, -vv, -vvv
: Рівень детальності виводу
Приклад виводу
Список
У випадку помилки
Записи не знайдені
Ліцензія
MIT