metaseller/tinkoff-invest-api-v2-yii2

Yii2 framework wrapper for unofficial PHP SDK for Tinkoff Invest API v2

0.1.14 2024-09-19 05:13 UTC

This package is auto-updated.

Last update: 2024-12-19 05:50:45 UTC


README

Это расширение позволяет использовать неофициальное PHP SDK for Tinkoff Invest API v2 metaseller/tinkoff-invest-api-v2-php, по факту являясь вокруг него оберткой для вашего Yii2 приложения.

Установка

Самый оптимальный способ установки - это использование composer.

Если вы ранее уже ранее устанавливали в своем проекте metaseller/tinkoff-invest-api-v2-php через Composer, то для начала стоит выполнить

$ php composer.phar remove metaseller/tinkoff-invest-api-v2-php

Если нет - пропустите этот шаг.

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

$ php composer.phar require metaseller/tinkoff-invest-api-v2-yii2:*

или добавьте

"metaseller/tinkoff-invest-api-v2-yii2": "*"

в секцию require вашего composer.json файла.

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

  1. Прочитайте требования к настройкам окружения в описании: https://github.com/metaseller/tinkoff-invest-api-v2-php

  2. Добавьте компонент в ваш глобальный конфигурационный файл проекта main.php:

'components' => [
    'tinkoffInvest' => [
        'class' => 'Metaseller\yii2TinkoffInvestApi2\TinkoffInvestApi',
        'apiToken' => '<Your Tinkoff Invest Account Token>',
    ],
],

Информация где взять токен здесь - https://tinkoff.github.io/investAPI/token/

  1. Теперь можно использовать компонент
/**
* Создаем экземпляр запроса информации об аккаунте к сервису
*
* Запрос не принимает никаких параметров на вход
*
* @see https://tinkoff.github.io/investAPI/users/#getinforequest
*/
$request = new GetInfoRequest();

/**
* @var GetInfoResponse $response - Получаем ответ, содержащий информацию о пользователе
*/
list($response, $status) = \Yii::$app->tinkoffInvest->usersServiceClient->GetInfo($request)->wait();

/** Выводим полученную информацию */
var_dump(['user_info' => [
   'prem_status' => $response->getPremStatus(),
   'qual_status' => $response->getQualStatus(),
   'qualified_for_work_with' => $response->getQualifiedForWorkWith(),
]]);

/**
* @var GetInfoResponse $response - Получаем ответ, содержащий информацию о пользователе
*/
list($response, $status) = \Yii::$app->tinkoffInvest->usersServiceClient->GetInfo($request)->wait();

/** Выводим полученную информацию */
var_dump(['user_info' => [
   'prem_status' => $response->getPremStatus(),
   'qual_status' => $response->getQualStatus(),
   'qualified_for_work_with' => $response->getQualifiedForWorkWith(),
]]);