Каталог пользователей вконтакте

Подключение

composer require nazbav/vk-coin-api
  1. Через Composer:
include "../vendor/autoload.php";

$coin = new \nazbav\VkCoinAPI\VkCoin(211984675, "45vyv45KJMKouj9retghrebtvrhtrehryvt54ONopiino");
  1. С обработкой исключений:
include "../vendor/autoload.php";

try {
    $coin = new \nazbav\VkCoinAPI\VkCoin(211984675, "45vyv45KJMKouj9retghrebtvrhtrehryvt54ONopiino");
//ваш код...
} catch (VkCoinException $e) {
    echo $e;
}
Параметр Тип Описание
$merchantId int ID странички, для которой был получен платёжный ключ
$key string Платёжный ключ
$checkResponse string Отлов ошибок, по умолчанию (см. ниже).

Примеры использования

const VK_KEY = ''; //токен сообщества или пользователя
const CONFIRM_STR = ''; //ключ авторизации сообщества, который вы получили
const VERSION = '5.101'; //ваша версия используемого api

Минимальный Callback бот для бесед и сообщества

require_once('vendor/autoload.php');
use DigitalStar\vk_api\vk_api;
$vk = vk_api::create(VK_KEY, VERSION)->setConfirm(CONFIRM_STR);
$data = $vk->initVars($id, $message, $payload, $user_id, $type); //инициализация переменных
if($type == 'message_new')
  $vk->reply($message);

Простой Callback бот для бесед и сообщества

require_once('vendor/autoload.php');
use DigitalStar\vk_api\vk_api;
$vk = vk_api::create(VK_KEY, VERSION)->setConfirm(CONFIRM_STR);
$vk->debug();
$data = $vk->initVars($id, $message, $payload, $user_id, $type); //инициализация переменных
$info_btn = $vk->buttonText('Информация', 'blue', ); //создание кнопки
if ($payload) {
    if($payload == 'info')
        $vk->reply('Тебя зовут %a_full%'); //отвечает пользователю или в беседу
} else
    $vk->sendButton($id, 'Видишь кнопку? Нажми на нее!', ]); //отправляем клавиатуру с сообщением

Простой LongPoll бот для юзера

require_once('vendor/autoload.php');
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\LongPoll;
$vk = vk_api::create('login', 'password', VERSION);//или используйте токен вместо лог/пас
$vk = new LongPoll($vk);
$vk->listen(function()use($vk){ //longpoll для пользователя
    $vk->on('message_new', function($data)use($vk) { //обработка входящих сообщений
        $vk->initVars($id, $message, $payload, $user_id, $type);
        $vk->reply($message);
    });
});

Простой LongPoll бот для сообщества

require_once('vendor/autoload.php');
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\LongPoll;
$vk = vk_api::create(VK_KEY, '5.101');
$vk = new LongPoll($vk);
$vk->listen(function($data)use($vk){ //в $data содержится все данные
    $vk->initVars($id, $message, $payload, $user_id, $type);
    $vk->reply($message);
});

Callback + Execute

Используется, когда callback скрипт во время выполнения много раз обращается к api, а вам нужно экономить запросы, чтобы не привышать лимит(высоконагруженные боты)

require_once('vendor/autoload.php');
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\Execute;
$vk = vk_api::create(VK_KEY, VERSION)->setConfirm(CONFIRM_STR);
$vk = new Execute($vk);
$vk->debug();
$data = $vk->initVars($id, $message, $payload, $user_id, $type); //инициализация переменных
$vk->reply($message); //отвечает пользователю или в беседу

LongPoll + Execute

Лучшая связка для высоконагруженных ботов. Но если вы делаете высоконагруженного бота, лучше посмотрите в сторону NodeJS, он справляется с этим намного лучше за счет асинхронности и многопоточности из коробки.

require_once('vendor/autoload.php');
use DigitalStar\vk_api\vk_api;
use DigitalStar\vk_api\LongPoll;
use DigitalStar\vk_api\Execute;
$vk = vk_api::create(VK_KEY, '5.95');
$vk = new Execute($vk);
$vk = new LongPoll($vk);
$vk->listen(function($data)use($vk){ //в $data содержится все данные события, можно убрать, если не нужен
    $vk->initVars($id, $message, $payload, $user_id, $type); //инициализация переменных
    $vk->reply($message);
});

Examples

Annotation

In all the examples below, I will give only the

async def func():
    {code}

loop = asyncio.get_event_loop()
loop.run_until_complete(func())

Authorization

TokenSession — if you already have token or you use requests which don’t require token

session = TokenSession()
session = TokenSession(access_token='asdf123..')

ImplicitSession — client authorization in js apps and standalone (desktop and mobile) apps

>>> session = ImplicitSession(USER_LOGIN, USER_PASSWORD, APP_ID)
>>> await session.authorize()
>>> session.access_token
asdfa2321afsdf12eadasf123...

With scopes:

ImplicitSession(USER_LOGIN, USER_PASSWORD, APP_ID, 'notify')
ImplicitSession(USER_LOGIN, USER_PASSWORD, APP_ID, 'notify,friends')
ImplicitSession(USER_LOGIN, USER_PASSWORD, APP_ID, )
ImplicitSession(USER_LOGIN, USER_PASSWORD, APP_ID, 3)  # notify and friends

Also you can use for entering confirmation code
or captcha key

AuthorizationCodeSession — authorization for server apps or Open API

>>> session = AuthorizationCodeSession(APP_ID, APP_SECRET, REDIRECT_URI, CODE)
>>> await session.authorize()
>>> session.access_token
asdfa2321afsdf12eadasf123...

Or:

>>> session = AuthorizationCodeSession(APP_ID, APP_SECRET, REDIRECT_URI)
>>> await session.authorize(CODE)
>>> session.access_token
asdfa2321afsdf12eadasf123...

Authorization using context manager — you won’t need to use session.close() after work

async with aiovk.TokenSession(access_token=YOUR_VK_TOKEN) as ses:
    api = API(ses)...

And your session will be closed after all done or code fail(similar to simple «with» usage)
Works with all types of authorization

Drivers

HttpDriver — default driver for using

>>> driver = HttpDriver()
>>> driver = HttpDriver(timeout=10)  # default timeout for all requests
>>> driver = Socks5Driver(PROXY_ADDRESS, PORT)  # 1234 is port
>>> driver = Socks5Driver(PROXY_ADDRESS, PORT, timeout=10)
>>> driver = Socks5Driver(PROXY_ADDRESS, PORT, PROXY_LOGIN, PROXY_PASSWORD, timeout=10)

How to use custom driver with session:

>>> session = TokenSession(..., driver=HttpDriver())

How to use driver with own loop:

>>> loop = asyncio.get_event_loop()
>>> asyncio.set_event_loop(None)
>>> session = TokenSession(driver=HttpDriver(loop=loop))  # or Socks5Driver

How to use driver with custom http session object:

>>> connector = aiohttp.TCPConnector(verify_ssl=False)
>>> session = aiohttp.ClientSession(connector=connector)
>>> driver = HttpDriver(loop=loop, session=session)

LimitRateDriverMixin — mixin class what allow you create new drivers with speed rate limits

>>> class ExampleDriver(LimitRateDriverMixin, HttpDriver):
...     requests_per_period = 3
...     period = 1  #seconds

VK API

First variant:

>>> session = TokenSession()
>>> api = API(session)
>>> await api.users.get(user_ids=1)

Second variant:

>>> session = TokenSession()
>>> api = API(session)
>>> await api('users.get', user_ids=1)

Also you can add argument for each request or define it in the session

Lazy VK API

It is useful when a bot has a large message flow

>>> session = TokenSession()
>>> api = LazyAPI(session)
>>> message = api.users.get(user_ids=1)
>>> await message()

Supports both variants like API object

User Long Poll

Use exist API object

>>> api = API(session)
>>> lp = UserLongPoll(api, mode=2)  # default wait=25
>>> await lp.wait()
{"ts":1820350345,"updates":}
>>> await lp.wait()
{"ts":1820351011,"updates":}

Use Session object

>>> lp = UserLongPoll(session, mode=2)  # default wait=25
>>> await lp.wait()
{"ts":1820350345,"updates":}
>>> await lp.get_pts()  # return pts
191231223
>>> await lp.get_pts(need_ts=True)  # return pts, ts
191231223, 1820350345

Notice that value only for long pool connection.

Real pause could be more time because of need time
for authorization (if needed), reconnect and etc.

Bots Long Poll

Use exist API object

>>> api = API(session)
>>> lp = BotsLongPoll(api, mode=2, group_id=1)  # default wait=25
>>> await lp.wait()
{"ts":345,"updates":}
>>> await lp.wait()
{"ts":346,"updates":}

Use Session object

>>> lp = BotsLongPoll(session, mode=2, group_id=1)  # default wait=25
>>> await lp.wait()
{"ts":78455,"updates":}
>>> await lp.get_pts()  # return pts
191231223
>>> await lp.get_pts(need_ts=True)  # return pts, ts
191231223, 1820350345

Notice that value only for long pool connection.

Real pause could be more time because of need time
for authorization (if needed), reconnect and etc.

getTop()

Возвращает список текущего топа.

Аргумент Тип Обязательный Описание
type

str

Тип возвращаемого топа ( или ).По умолчанию — .
coin.getTop()
>>> [
     {'id': 67580761,
      'score': 473553513081870,
      'name': 'КБ',
      'screen_name': 'countryballs_re',
      'is_closed': ,
      'type': 'page',
      'photo_200': 'https://sun9-18.userapi.com/c850420/v850420990/ff275/6svrAL6jtME.jpg?ava=1',
      'link': 'https://vk.com/club67580761'},
     {'id': 98699940,
     'score': 473550301524363,
     'name': "Bratishkin's Stream",
     'screen_name': 'bratishkinoff',
     'is_closed': ,
     'type': 'page',
     'photo_200': 'https://sun9-9.userapi.com/c851416/v851416466/fcfa5/LZGnlIJVEBw.jpg?ava=1',
     'link': 'https://vk.com/club98699940'}
    ]
Ссылка на основную публикацию