
Security News
Astral Launches pyx: A Python-Native Package Registry
Astral unveils pyx, a Python-native package registry in beta, designed to speed installs, enhance security, and integrate deeply with uv.
node-vkapi
Advanced tools
$ npm install node-vkapi --only=prod
Refer to README_EN.md for english docs.
const vkapi = new (require('node-vkapi'))();
// Получение некоторых данных о пользователе id1
// и вывод их в консоль.
vkapi.call('users.get', {
user_ids: '1',
fields: 'verified,sex'
})
.then(users => console.dir(users[0]))
.catch(error => console.error(error));
options<Object>
Опции экземпляра VkApiСвойства объекта options и их значения по умолчанию.
{
accessToken: null, // <String> Ключ доступа
apiVersion: '5.68', // <String> Версия API
appId: null, // <Number> ID приложения ВКонтакте
appSecret: null, // <String> Секретный ключ приложения ВКонтакте
captchaApiKey: null, // <String> API ключ сервиса по распознаванию капчи
captchaService: 'anti-captcha', // <String> Сервис по распознаванию капчи (anti-captcha, antigate, rucaptcha)
userLogin: null, // <String> Логин пользователя
userPassword: null, // <String> Пароль пользователя
baseDelay: 334 // <Number> Базовая задержка между вызовами API (334 составляет ~1/3 секунды и используется для авторизации через токен пользователя)
}
params<Object>
Параметры запросаPromise<AuthResponseObject>
Осуществляет прямую авторизацию, т.е. авторизует пользователя в одном из официальных приложений ВКонтакте, используя логин и пароль пользователя.
Параметры запроса на прямую авторизацию и их значения по умолчанию.
{
client: 'android', // <String> Клиент (android, iphone)
login: vkapi.options.userLogin, // <String> Логин пользователя
password: vkapi.options.userPassword, // <String> Пароль пользователя
scope: MAX_SCOPE // <String> Строка разрешений. По умолчанию будут запрашиваться все возможные разрешения
}
method<String>
Название методаparams<Object>
Параметры методаPromise<Any>
Вызывает методы API ВКонтакте.
При вызове метода
execute
будет возвращён полный ответ от ВКонтакте. Подробнее
params<Object>
Параметры запросаPromise<AuthResponseObject>
Авторизует пользователя через мобильную Web-версию ВКонтакте.
При этом есть возможность использовать ID неофициального приложения.
Параметры запроса на авторизацию через Web-версию и их значения по умолчанию.
{
appId: vkapi.options.appId, // <Number> ID приложения ВКонтакте
login: vkapi.options.userLogin, // <String> Логин пользователя
password: vkapi.options.userPassword, // <String> Пароль пользователя
scope: MAX_SCOPE // <String> Строка разрешений. По умолчанию будут запрашиваться все возможные разрешения
}
type<String>
Тип загрузкиfiles<Any>
Файл(ы) к загрузкеparams<Object>
Параметры запроса на получение URL для загрузки. ПодробнееafterUploadParams<Object>
Параметры запроса на сохранение загруженного файла. ПодробнееPromise<Any>
Выполняет загрузку файлов во ВКонтакте.
Не забывайте, что для загрузки файлов вы должны иметь соответствующие разрешения.
audio
Аудиозаписьcover
Обложка сообществаdocument
Документdocument_pm
Документ в личное сообщениеdocument_wall
Документ на стенуphoto_album
Фотография(ии) в альбомphoto_main
Главная фотографияphoto_market
Фотография для товараphoto_market_album
Фотография для подборки товаровphoto_pm
Фотография в личное сообщениеphoto_wall
Фотография на стенуvideo
ВидеозаписьПеременная files может быть как единственным файлом к загрузке, так и массивом файлов (только для типа photo_album). Каждый отдельный файл должен представлять собой FS Stream либо объект, который содержит следующие свойства:
Свойство | Тип | |
---|---|---|
content | Buffer | Содержимое файла |
name | String | Имя файла |
Для того, чтобы загрузить граффити или аудио-сообщение, нужно указать document
как тип загрузки, а в параметрах запроса params
указать тип загружаемого документа: для граффити — это graffiti
, для аудио-сообщения — audio_message
.
// Простейший пример загрузки аудио-сообщения
const fs = require('fs');
const vkapi = new (require('node-vkapi'))({ accessToken: 'your_access_token' });
vkapi.upload('document', fs.createReadStream('./path/to/audiofile.mp3'), { type: 'audio_message' })
.then(response => console.dir(response))
.catch(error => console.error(error));
Примеры загрузки файлов вы можете найти в папке examples.
Функции vkapi.authorize()
и vkapi.logIn()
возвращают ответ в одинаковом формате.
{
access_token // <String> Ключ доступа
expires_in // <Number> Время в секундах, через которое ключ станет недействительным
user_id // <Number> ID пользователя
?email // <String> E-mail пользователя. Включается в ответ, если был запрошен в параметре "scope" при авторизации
}
FAQs
Node.js SDK for Vkontakte API (vk.com)
The npm package node-vkapi receives a total of 3 weekly downloads. As such, node-vkapi popularity was classified as not popular.
We found that node-vkapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Astral unveils pyx, a Python-native package registry in beta, designed to speed installs, enhance security, and integrate deeply with uv.
Security News
The Latio podcast explores how static and runtime reachability help teams prioritize exploitable vulnerabilities and streamline AppSec workflows.
Security News
The latest Opengrep releases add Apex scanning, precision rule tuning, and performance gains for open source static code analysis.