Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azzzak/vkapi
Golang-пакет для работы с API VK
https://github.com/azzzak/vkapi
golang vk vk-api vk-sdk
Last synced: about 2 months ago
JSON representation
Golang-пакет для работы с API VK
- Host: GitHub
- URL: https://github.com/azzzak/vkapi
- Owner: azzzak
- License: mit
- Created: 2019-09-01T16:08:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-13T20:28:49.000Z (almost 4 years ago)
- Last Synced: 2024-10-10T18:23:09.944Z (2 months ago)
- Topics: golang, vk, vk-api, vk-sdk
- Language: Go
- Size: 84 KB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vkapi [](https://godoc.org/github.com/azzzak/vkapi) [](https://goreportcard.com/report/github.com/azzzak/vkapi)
Golang-пакет для работы с API VK.
Версия протокола **101**.
## Получение токена
Варианты получения токена описаны на [странице](https://vk.com/dev/access_token).
Для получение пользовательского токена через _Implicit flow_ можно воспользоваться утилитой в папке `cmd`. Она принимает _id_ (идентификатор приложения) и _scope_ (настройки доступа). Например:
`go run main.go -id=1234567 -scope=photos,wall,groups`
После запуска надо открыть страницу [http://localhost:3000/token](http://localhost:3000/token), которая направит на сайт VK для подтверждения доступа. В случае согласия токен будет доступен в адресной строке.
Самый простой способ получить токен сообщества — создать его в настройках: `Управление > Работа с API > Создать ключ`.
## Правила
- Если параметр принимает значение **0** или **1**, то используется тип `bool`
- Для числовых идентификаторов используется тип `int`
- Для списка идентификаторов используется тип `[]int`
- Если параметр ожидает JSON-строку, то ему передается соответствующая структура, которая будет сериализована автоматически
- Если метод возвращает **1** в случае успеха, то используется тип `bool`
Иногда параметры могут изменять формат выдачи, в этих случаях возвращается тип `interface{}`, который перед использованием потребуется привести к нужному типу. Возможные варианты описаны в комментариях к методам.
## Пример
```Go
// создаем клиент для работы с API, передаем пользовательский токен
vk := vkapi.NewClient("token")
// создаем новый альбом
createParams := vkapi.PhotosCreateAlbumParams{
Title: "New album",
}
album, _ := vk.PhotosCreateAlbum(createParams)
// получаем адрес для загрузки в новый альбом
getUploadURLParams := vkapi.PhotosGetUploadServerParams{
AlbumID: album.ID,
}
upload, _ := vk.PhotosGetUploadServer(getUploadURLParams)
// загружаем фото по полученному адресу
u, _ := vkapi.UploadAlbumFromFile(upload.UploadURL, "photo.jpg")
// сохраняем загруженное фото
saveParams := vkapi.PhotosSaveParams{
Server: u.Server,
AlbumID: u.AID,
PhotosList: u.PhotosList,
Hash: u.Hash,
}
photo, _ := vk.PhotosSave(saveParams)
// постим фото на стену
postParams := vkapi.WallPostParams{
Attachments: vkapi.MakeAttachment("photo", photo[0].OwnerID, photo[0].ID),
}
vk.WallPost(postParams)
```
## Реализованные методы
| Группа методов | | Готово / Всего |
| -------------- | :-: | :------------: |
| account | | **0** / 19 |
| appWidgets | | **0** / 8 |
| apps | | **0** / 8 |
| auth | | **0** / 2 |
| board | | **0** / 13 |
| database | ✓ | **12** / 12 |
| docs | | **0** / 11 |
| fave | | **0** / 23 |
| friends | ✓ | **18** / 18 |
| gifts | | **0** / 1 |
| groups | ✓ | **45** / 45 |
| leadForms | | **0** / 7 |
| likes | | **0** / 4 |
| market | | **0** / 24 |
| messages | ✓ | **38** / 38 |
| newsfeed | | **0** / 15 |
| notes | | **0** / 10 |
| notifications | | **0** / 3 |
| pages | | **0** / 8 |
| photos | ✓ | **46** / 46 |
| polls | | **0** / 9 |
| prettyCards | | **0** / 6 |
| search | ✓ | **1** / 1 |
| stats | | **0** / 3 |
| status | ✓ | **2** / 2 |
| storage | | **0** / 3 |
| stories | | **0** / 14 |
| streaming | | **0** / 5 |
| users | | **0** / 6 |
| utils | | **0** / 7 |
| video | | **0** / 24 |
| wall | ✓ | **23** / 23 |
| widgets | | **0** / 2 |
## Использование остальных методов
Вызвать метод, который пока не реализован можно с помощью функции `Request`. Она принимает название метода, структуру с параметрами и ссылку на структуру, которая будет заполнена ответом метода.