igusev/sdk

Botan.io libs & SDK

#Botan SDK

Botan is a telegram bot analytics system based on Yandex.Appmetrica. In this document you can find how to setup Yandex.Appmetrica account, as well as examples of Botan SDK usage.

Creating an account

• Register at http://appmetrica.yandex.com/
• After registration you will be prompted to create Application. Please use @YourBotName as a name.
• Save an API key from settings page, you will use it as a token for Botan API calls.
• Download lib for your language, and use it as described below. Don`t forget to insert your token!

SDK usage

We have libraries for the following languages:

• JavaScript
• Python
• Ruby

More languages (PHP, Java, C#, etc.) are coming soon!

Alternatively, you can use Botan API via HTTP calls (please see below).

Javacript example

Install npm: npm install botanio

var botan = require('botanio')(token);

botan.track(message, 'Start');

Python example

You need to install requests library to use python botan lib. You can do it like this: pip install requests

Code:

import botan
token = 1
uid = 2    
messageDict = {}
print botan.track(token, uid, messageDict, 'Search')

It's necessary to pass uid (user id you get from Telegram) into python lib calls.

Ruby example

uid is a user id you get from Telegram.

require_relative 'botan'
token = 1111
uid = 1
message = { text: 'text' }
puts Botan.track(token, uid, message, 'Search')

HTTP API

The base url is: https://api.botan.io/track

You can put data to Botan using POST method.

The url should look like https://api.botan.io/track?token=API_KEY&uid=UID

Please provide a json document as the post body.

API response is a json document:

• on success: {"status": "accepted"}
• on failure: {"status": "failed"} or {"status": "bad request"}

##Contribution We welcome any contributions as pull-requests!

Feel free to write more libraries for the languages we are not supporting yet.