VKKeksikLib v7.13.2.1

Библиотека для использования API донат - сервиса "Пончик" ВКонтакте Используемое API: https://keksik.io/api

Cистема версий:

Текущая версия библиотеки (Если она изменилась - вам придется обновить свой проект!). Количество функций API. Количество дополнительных функций. Количество конвертеров

Getting Started

Эта инструкция позволит вам просто и быстро начать работать с API.

Install

Установите Nuget пакет в ваш проект: Package Manager

PM> Install-Package VKKeksikLib

.NET CLI

> dotnet add package VKKeksikLib

Visual Studio Nuget Manager

Проект -> Свойства -> Управление пакетами Nuget -> Обзор -> Поиск -> VKKeksikLib -> Установить

Поддержать разработку проекта

Данная библиотека распространяется бесплатно, но вы можете поддержать ее разработку, отправив средства разработчику

Prerequisites

В библиотеке последней версии реализовано использование CallBack API и отправка запросов к обычному API для получения/изменения информации о донатах В следующем обновлении запранирована переработка CallBack API, а также добавление новых функций

Использование

Создайте экзеспляр класса PonchikClient для дальнейшего использования API

VKKeksikLib.PonchikClient Client = new VKKeksikLib.PonchikClient(SecretKey, ConfirmKey);

Example

Использование CallBack API (Рекомендуется использовать в проектах веб-приложения или ASP.NET):

В версии 7 был добавлен отдельный класс для обычных подтверждений запросов и изменен класс для первого подтверждения!

/* Эвент загрузки страницы ASP.NET */
public partial class CallBack : System.Web.UI.Page
{
    /* Создаем экземпляр класса PonchikClient и передаем ему секретный ключ и код подтверждения */
    VKKeksikLib.PonchikClient.CallBack Client = new VKKeksikLib.PonchikClient.CallBack(GroupID, APIToken, SecretKey, ConfirmKey);

    protected void Page_Load(object sender, EventArgs e)
    {
        string json;
        /* Принимаем входящий поток */
        using (var reader = new StreamReader(Request.InputStream))
        {
            /* Считываем данные в строку */
            json = reader.ReadToEnd();
        }

        /* Объявляем функцию для эвента OnNewConfirmation */
        Client.OnNewConfirmation += Confirmation;
        /* Объявляем функцию для эвента OnNewDonate */
        Client.OnNewDonate += Donate;
        /* Объявляем функцию для эвента OnNewPaymentStatus */
        Client.OnNewPaymentStatus += PaymentStatus;
        /* Объявляем функцию для эвента OnError */
        Client.OnError += CBError;

        /* Передаем в обработчик CallBack запросов полученный JSON массив */
        Client.Input(json);
    }

    /* Объявляем функцию для обработки запросов типа confirmation */
    private void Confirmation(string type, string answer)
    {
        // Поместите свой код здесь
    }
    
    /* Объявляем функцию для обработки запросов типа new_donate */
    private void Donate(string type, string answer, object obj)
    {
        // Поместите свой код здесь
    }
    
    /* Объявляем функцию для обработки запросов типа payment_status */
    private void PaymentStatus(string type, string answer, object obj)
    {
        // Поместите свой код здесь
    }
    
    /* Объявляем функцию для обработки запросов типа error */
    private void CBError(string type, string answer, object obj)
    {
        // Поместите свой код здесь
    }
}

Использование Функций PonchikClient.Donate

/* Создаем новый экземпляр класса Donate */
var pl = new VKKeksikLib.PonchikClient.Donate(GroupID, SecretKey, ConfirmKey);
/* Получение списка донатов */
string GetResult = VKKeksikLib.Converters.Serialize.ToJson(pl.Get());
/* Изменить статус доната */
string ChangeStatusResult = VKKeksikLib.Converters.Serialize.ToJson(pl.ChangeStatus(0123456, "Status"));
/* Добавить/изменить ответ сообщества на донат */
string AnswerResult = VKKeksikLib.Converters.Serialize.ToJson(pl.Answer(0123456, "Answer"));
/* Изменить выдачи вознаграждения */
string ChangeRewardStatusResult = VKKeksikLib.Converters.Serialize.ToJson(pl.ChangeRewardStatus(0123456, "Status"));

Использование Функций PonchikClient.Campaign

/* Создаем новый экземпляр класса Donate */
var pl = new VKKeksikLib.PonchikClient.Campaign(GroupID, SecretKey, ConfirmKey);
/* Получить список краудфандинговых кампаний (последние 20 кампаний) */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.Get(new int[3] { 01234560, 01234561, 01234563 }));
/* Получить активную краудфандинговую кампанию */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.GetActive());
/* Получить список вознаграждений краудфандинговой кампании */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.GetRewards(0123456));
/* Обновить информацию о краудфандинговой кампании */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.Change(0123456, "Title", "Status", 0, 11000, 0, 0));
/* Обновить информацию о вознаграждении краудфандинговой кампании */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.ChangeReward(0123456, "Title", "Desc", 500, 0, "hidden"));

Использование Функций PonchikClient.Payment

/* Создаем новый экземпляр класса Payment */
var pl = new VKKeksikLib.PonchikClient.Payment(Base.CDB.GroupID, Base.CDB.SecretKey, Base.CDB.ConfirmKey);
/* Получить список заявок на выплату (последние 20 заявок). */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.Get(new int[3] { 01234560, 01234561, 01234563 }));
/* Создать заявку на выплату */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.Create(System, Purse, Ammount));

Использование Функций PonchikClient.Balance

/* Создаем новый экземпляр класса Balance */
var pl = new VKKeksikLib.PonchikClient.Balance(Base.CDB.GroupID, Base.CDB.SecretKey, Base.CDB.ConfirmKey);
/* Получить баланс группы в приложении */
Base.CDB.result = VKKeksikLib.Converters.Serialize.ToJson(pl.Get());

Использование Функции SendPostJSON

string response = Client.SendPostJSON("https://example.com/", "{ \"json\" }");

Использование Функции SendPostJSON

string response = Client.SendPostJSON("https://example.com/", "{ \"json\" }");

Использование Функции GetErrorCodeInfo

string ErrorDescription = Client.GetErrorCodeInfo(IntErrorCode);

TODOs

• Реализовать проверку и использование CallBack API
• Реализовать получение списка донатов
• Реализовать изменение статуса доната
• Реализовать добавление/измение ответа сообщества на донат
• Реализовать изменение выдачи вознаграждения
• Реализовать получение списка краудфандинговых кампаний (последние 20 кампаний)
• Реализовать получение активной краудфандинговой кампании
• Реализовать получение списка вознаграждений краудфандинговой кампании
• Реализовать обновление информации о краудфандинговой кампании
• Реализовать обновление информации о вознаграждении краудфандинговой кампании
• Реализовать получение списка заявок на выплату (последние 20 заявок)
• Реализовать создание заявки на выплату
• Реализовать получение баланса группы
• Реализация дополнительных функций
• Публикация ДЕМО проекта с документацией
• Полная версия ДЕМО проекта
• Полная версия документации

• Связатся со мной
• LonDev WebSite