Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ciricc/easyvk
This app helps you create an apps with vk api easy!
https://github.com/ciricc/easyvk
api callback-api longpoll nodejs npm npm-module sdk snippets streaming-api vk vk-api
Last synced: 3 months ago
JSON representation
This app helps you create an apps with vk api easy!
- Host: GitHub
- URL: https://github.com/ciricc/easyvk
- Owner: ciricc
- License: mit
- Archived: true
- Created: 2017-12-09T12:03:37.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T01:11:22.000Z (almost 3 years ago)
- Last Synced: 2024-09-21T15:33:37.650Z (3 months ago)
- Topics: api, callback-api, longpoll, nodejs, npm, npm-module, sdk, snippets, streaming-api, vk, vk-api
- Language: JavaScript
- Size: 6.14 MB
- Stars: 101
- Watchers: 4
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyVK (VKontakte API Manager) v2.0 (DEPRECATED)
## This package has been deprecated and will no longer be supported.
This library helps you easily create a javascript application with VKontakte API!
Official VK API: [vk.com/dev/](https://vk.com/dev/)
[](https://www.codacy.com/app/ciricc/easyvk?utm_source=github.com&utm_medium=referral&utm_content=ciricc/easyvk&utm_campaign=Badge_Grade) [](https://travis-ci.org/ciricc/easyvk) [](https://npms.io/search?q=easyvk) [](https://github.com/ciricc/easyvk/issues)
[](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V10.md#10.15.3) [](https://www.npmjs.com/package/easyvk)
| [Community](https://vk.com/club162208999) | [Документация на русском](https://ciricc.github.io/) |
| ------------------------------------------| -------------|
## Для русскоязычных
Данная библиотека создана для того, чтобы VKontakte API имел удобную поддержу на node.js.
С помощью этой библиотеки вы можете делать все, что позволяет официально ВКонтакте API, и не только.
Так как я предполагаю, что большинство людей, кто скачивает - владеют русским с рождения, то я написал [документацию](https://ciricc.github.io/) для этого модуля на этом языке.
Если вы хотите помочь в развитии этой библиотеки, вступайте в наше [сообщество](https://vk.com/club162208999) и предлагайте, что можно улучшить и добавить.
Если вы хотите помочь нам кодом - делайте это на [github](https://github.com/ciricc/easyvk).
Ниже написано, что можно делать при помощи EasyVK.
## Installing
Download and install Node.js. Create a project and install `easyvk` with `npm`:
```sh
npm i easyvk --save
```
### Yarn installation
If you are using a yarn package manager, you can add easyvk to project so
```sh
yarn add easyvk
```
## Example usage
You can test the library without installing on [npm runkit](https://npm.runkit.com/easyvk).
Copy this code and paste it in the code area, don't forget to change username and password.
```javascript
const easyvk = require("easyvk")
//Authenticating user
easyvk({
username: 'your_login',
password: 'your_password',
save: false,
// By default are vk android credentials
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET'
}).then(vk => {
//Getting user id from authenticated session
let me = vk.session.user_id || 356607530 //Or your account id
//Sending a message using messages.send method
vk.call('messages.send', {
message: 'Hi',
user_id: me,
random_id: easyvk.randomId()
}).then((vkr) => console.log(vkr))
}).catch(console.error)
```
## EasyVK can help you
* Create Bots
* Manage groups
* Use LongPoll: Bots LongPoll (groups) and User LongPoll
* Create high loading projects with highload mode
* Use Callback API (like creating your server to listen to group events)
* Manage your stream based on official Streaming API, listen to events and collect data to create statistic and metrics
* Upload your files to the server
* Call official VKontakte API methods
* Use my widgets - non-official instruments for everyday tasks
* Use helpers - utility for creating something that you need everyday
* Use saved session, cache data to saved session
* Catch errors like Captcha error and others
* Configure all that you want or not (utils can bee disabled or enabled by you)
## EasyVK provide
* Promises and async / await based library
* Authentication support: groups, users, applications, password + username
* Informative documentation
* Regular updates and support for newest features
* Two factor authentication support
* Easy working with captcha errors and captcha handlers
* Easy customize your requests and easy control them
You can read documentation here
## Что дает EasyVK
Узнайте, зачем Вам может понадобиться Easy VK, и что именно он может вам дать!
### Режим параллельных запросов
В Easy VK есть режим `highload`, включая который, вы сможете использовать все возможности API ВКонтакте даже при большом количестве запросов. Этот режим дает знать библиотеке, что все запросы необходимо выполнять через метод execute, который выполняет до 25 запросов в секунду.
Может пригодиться чат-ботам, в которых сообщений в тысячи раз больше, чем пользователей.
```javascript
easyvk({
token: "{GROUP_TOKEN}",
reauth: true,
mode: 'highload' || {
timeout: 10,
name: 'highload'
}
}).then(async (vk) => {
let connection = await vk.bots.longpoll.connect();
connection.on('message_new', console.log);
});
```
### Плагины
Теперь в Easy VK будет поддерживаться разработка новых плагинов. Функционал API для плагинов будет дополняться по мере просьб и нужд разработчиков, я всегда буду рад обновлениям.
```javascript
// Разработка простейшего плагина для отправки сообщений
vk.use(async ({thread, next}) => {
if (thread.method == "messages.send") {
// Автоматически меняем типа запроса на POST
thread.methodType = "post";
if (Number(thread.query.v) >= 5.90) {
/* Для новых версий API ВКонтакте для сообщений
требует поля random_id (уникальный id сообщения) */
thread.query.random_id = easyvk.randomId();
}
}
// Запускаем следующий плагин
await next();
});
```
### Client Credentials Flow и авторизация по приложению
```javascript
easyvk({
clientId: '{APP_SECRET_CODE}',
clientSecret: '{CLIENT_SECRET_CODE}',
utils: {
streamingAPI: true
}
}).then((vk) => {
const StreamingAPI = vk.streamingAPI
return StreamingAPI.connect().then((connection) => {
connection.getRules().then((vkr) => {
console.log(vkr.rules);
});
connection.on("post", console.log);
});
});
```
### LongPoll API
Создавайте своих чат-ботов с помощью Easy VK и его возможностей LongPoll API
```javascript
//bots
vk.bots.longpoll.connect({
forGetLongPollServer: {
grop_id: vk.session.group_id
}
}).then((connection) => {
connection.on("message_new", (msg) => {
//On message event
vk.call("messages.send", {
peer_id: msg.from_id,
message: "Reply it!",
random_id: easyvk.randomId()
}).catch(console.error);
});
});
//user longpoll
vk.longpoll.connect({}).then((connection) => {
connection.on("message", (event) => {
console.log(event);
});
//changed state of message
connection.addEventCodeListener(3, (eventChangeState) => {
console.log(eventChangeState);
});
});
```
### Streaming API
Собирайте статистические данные о популярности тех или инных продуктов, проектов - чего угодно! Это позволит Вам знать, о чем пишут пользователи ВКонтакте, и кто из них - ваши клиенты!
```javascript
easyvk({
clientId: '{APP_SECRET_CODE}',
clientSecret: '{CLIENT_SECRET_CODE}',
utils: {
streamingAPI: true
}
}).then(vk => {
vk.streamingAPI.connect((stream) => {
stream.initRules({
key1: 'кошка',
key2: 'собака -кот'
}).then((changes) => {
console.log(changes.changedRules, changes.deletedRules, changes.addedRules);
stream.on("post", (postEvent) => {
console.log("Post info: ", postEvent);
});
//.on(...)
//.on("share")
//.on("comment") etc...
});
});
})
```
### Callback API
Создавайте чат-ботов (и не только) с помощью Callback API, имея собственный сервер с открытым доступом в интернете.
```javascript
easyvk.callbackAPI.listen({
port: process.env.PORT || 8080,
groups: [
{
groupId: 11,
confirmCode: 'TestConfirmationCode',
secret: 'GroupPassword'
},
{
/*....*/
}
]
}).then((connection) => {
connection.on('message_new', (msg) => {
console.log(msg.group_id);
});
}).catch(console.error);
```
Все остальное находится на сайте-документации проекта.