darkdarin / vk-ord-sdk
SDK for work with VK ORD API
Installs: 321
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:package
Requires
- php: 8.2.*|8.3.*
- darkdarin/serializer: ^1.3
- php-http/multipart-stream-builder: ^1.3
- psr-discovery/http-client-implementations: ^1.0
- psr-discovery/http-factory-implementations: ^1.0
- psr/http-client: ^1.0
- psr/http-factory: ^1.0
- psr/http-message: ^2.0
Requires (Dev)
- hyperf/di: ~3.0.0
- illuminate/support: ^10.0
- laravel/pint: ^1.1
- roave/security-advisories: dev-latest
README
SDK для работы с VK ORD API
Документация API: https://ord.vk.com/help/api/
Swagger-документация: https://ord.vk.com/help/api/swagger/
Данный SDK поддерживает все методы и типы объектов, используемых в API на 22.09.2024
Установка и настройка
Для установки пакета выполните команду:
composer require darkdarin/vk-ord-sdk
Laravel 10+
Опубликуйте конфигурацию с помощью команды
php artisan vendor:publish --provider "DarkDarin\VkOrdSdk\VkOrdSdkServiceProvider"
Hyperf 3.0
Опубликуйте конфигурацию с помощью команды
php bin/hyperf.php vendor:publish darkdarin/vk-ord-sdk
Использование
Standalone
use DarkDarin\VkOrdSdk\TransportClient\TransportClient; use DarkDarin\VkOrdSdk\Factories\PsrClientFactory; use DarkDarin\VkOrdSdk\Factories\PsrRequestFactoryFactory; use DarkDarin\VkOrdSdk\Factories\PsrStreamFactoryFactory; use DarkDarin\Serializer\ApiSerializer\ApiSerializerFactory; use DarkDarin\Serializer\MethodParametersSerializer\MethodParametersMapper; use DarkDarin\VkOrdSdk\VkOrd; $transportClient = new TransportClient( (new PsrClientFactory())(), (new PsrRequestFactoryFactory())(), (new PsrStreamFactoryFactory())(), (new ApiSerializerFactory())(), new MethodParametersMapper() ); $vkClient = new VkOrd('https://api.ord.vk.com', 'TOKEN', $transportClient); $contract = $vkClient->getContract('5t33p36p8p-1h57fjo00');
Laravel
use Illuminate\Support\Facades\App; use DarkDarin\VkOrdSdk\VkOrd; // Получить сконфигурированный клиент можно через DI любым доступным способом // https://laravel.com/docs/10.x/container $vkClient = App::make(VkOrd::class); $contract = $vkClient->getContract('5t33p36p8p-1h57fjo00');
Hyperf
use Hyperf\Context\ApplicationContext; use DarkDarin\VkOrdSdk\VkOrd; // Получить сконфигурированный клиент можно через DI любым доступным способом // https://hyperf.wiki/3.0/#/en/di $vkClient = ApplicationContext::getContainer()->get(VkOrd::class); $contract = $vkClient->getContract('5t33p36p8p-1h57fjo00');
Вызов методов с другим URL или токеном
/** @var \DarkDarin\VkOrdSdk\VkOrd $vkClient **/ $contract = $vkClient->withUrl('https://api-sandbox.ord.vk.com') ->withToken('SANDBOX_TOKEN') ->getContract('5t33p36p8p-1h57fjo00');