cyberlis / vknim

Wrapper for vk.com API written in nim-lang

vknim

Contains a wrapper for the vk.com API written in nim lang

This module is a wrapper for vk.com API. It gives you the ability to call vk.com API methods using synchronous and asynchronous approach.

In addition this module exposes macro @ to ease calling API methods

vk.com uses https, so you need to use -d:ssl compilation flag

Example: nim c -d:ssl -r myvkapp.nim

Here is some examples of how to use this module

Initialization:

import vknim

# Synchronous VK API
let api = newVkApi(token="you access token here")

# Asynchronous VK API
let asyncApi = newAsyncVkApi(token="you access token here")

Synchronous VK API examples:

# simple apiRequest
echo api.apiRequest("friends.getOnline")
echo api.apiRequest("fave.getPosts", {"count": "1"}.toApi)
echo api.apiRequest("wall.post", {"friends_only"="1", "message"="Hello world from nim-lang"}.toApi)

# awesome beautiful macros
echo [e-mail]()
echo [e-mail](count=1)
echo [e-mail](friends_only=1, message="Hello world fom nim-lang")

Asynchronous VK API examples:

import asyncdispatch
echo waitFor asyncApi.apiRequest("wall.get", {"count": "1"}.toApi)
echo waitFor [e-mail](count=1)

@ macro

@ macro gives you the ability to make API calls in more convenient manner

Left argument is VkApi or AsyncVkApi object. Right is a namespace and method name separated by dot.

And finally in parentheses you can specify any number of named arguments.

@ macro converts your requests to apiRequest calls Example:

echo [e-mail]()
echo [e-mail](count=1, offset=50)
echo [e-mail](friends_only=1, message="Hello world fom nim-lang")

How to get access key for API

To use vk.com api. You need to get access_key.

All information you can get on Vk manual page

Firstly you need to create your own Standalone Application

You can find other information about access key here.

And here you can find all available VK API methods