README

Данный пакет позволяет легко интегрировать все возможности OpenDataBot с Вашим проектом. Все что надо это установить, настроить и начать использовать нужные Вам запросы.

Установка

Для начала установите пакет выполнив команду в терминале:

composer require vivalaz/odb-api-connector

Использование

ВАЖНО: Перед началом работы с пакетом Вы должны получить API ключ для работы с OpenDataBot!

OpenDataBot API Connector включает в себя все эндпоинты по каждой из категорий доступных в документации:

Категория	Сервис
Компании и ФОП	`CompanyService`
Судебный реест	`CourtService`
Транспорт	`TransportService`
Физические лица	`PhysicalPersonService`
Мониторинг бизнеса	`BusinessMonitoringService`
Работа АПИ	`BaseService`
Поисковые запросы	`CompanyService`
Исполнительные производства	`PenaltyService`
КОАТУУ	`KoatuuService`
Недвижимость	`RealEstateService`

Если Вы не хотите использовать все сервисы, а только несколько, то Вам достаточно лишь создать экземпляр нужного сервиса.

Если же Вы хотите использовать все сервисы сразу, тогда можно использовать Builder, так же создав экземпляр этого класса.

Создав экземпляр нужного Вам сервиса или Builder'а передайте в метод setArgs API ключ полученный от OpenDataBot. Дальше можно использовать Все доступные Вам методы!

Credits

Opendatabot - платформа для работы с открытыми государственными данными. API предоставляет актуальные данные из Единого реестра предприятий и организаций, судебного реестра, реестр исполнительных производств, реестра налоговых долгов, расписания судебных заседаний, реестра налоговых долгов, реестра плательщиков НДС и других.

Главный сайт: https://opendatabot.ua/ Документация: https://docs.opendatabot.com/

vivalaz / odb-api-connector

Maintainers

Details

README

Установка

Использование

Credits