TGmembership API Документация

Интегрирайте своят Telegram бот с уебсайта си и продавайте абонаменти бързо и ефективно.


Първи стъпки

Като потребител на TGmembership, Вие можете да използвате нашият API за автоматизирате управлението на своите абонаменти. Например, можете да свържете своят Telegram бот директно към уебсайта си и да предоставите автоматичен достъп на своите клиенти до свързаните платени Telegram канали и групи.

Преди да можете да използвате API на TGmembership, уверете се, че имате вече създадени свой собствен бот и API ключ. Ако все още нямате, създайте свой собствен бот и го свържете към TGmembership. За да получите API ключ, отворете настройките на своят бот и изберете под-меню API.


Оторизация

API на TGmembership използва API ключ, за да оторизира заявките. Вие можете да видите и управлявате своят API ключ от настройките на своят бот.

Всички заявки към API на TGmembership трябва да бъдат изпращани чрез HTTPS, използвайки GET HTTP метод и трябва да бъдат оформени според следният формат:
https://api.tgmembership.com/bot<ID_НА_ВАШИЯТ_БОТ>/<API_КЛЮЧ>/<МЕТОД>

Заявки изпратени чрез HTTP ще бъдат неуспешни. API заявки без нужната оторизация също ще бъдат неуспешни. Методите използвани от TGmembership API не правят разлика между малки или главни бувки.

Отговорът съдържа JSON обект, който винаги има Boolean елемент "ok", Integer елемент "code" и може да има опционален String елемент "description" с четливо обяснение на резултата от заявката. Ако "ok" е равно на true, заявката е била успешна и резултатът от нея може да бъде открит в "result" елемента. В случай на неуспешна заявка, "ok" е равно на false и причината е посочена в "description".


Налични методи


Примерна заявка

curl https://api.tgmembership.com\
/bot1234567890\
/abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMN\
/getPlans?plan_id=1
                    
Примерен отговор
{
  "ok":true,
  "code":200,
  "result":[
    {
      "plan_id":"1",
      "plan_name":"My first plan",
      "duration":"1 month",
      "cost":"9.99",
      "currency":"EUR",
      "recurring":"0"
    }
  ]
}
GET /getPlans 

Връща списък с всички налични планове.

 
ПараметърТипЗадължителен?Описание
plan_idIntegerНеФилтрирай отговора по plan_id.
Ако липсва, всички резултати ще бъдат върнати.
limitIntegerНеЛимит на броят обекти, които заявката ще върне. Лимитът може да бъде в диапазона между 1 и 100.
Ако липсва, всички резултати ще бъдат върнати.

За да създадете нов план, използвайте командата /addplan към Вашият TGmembership бот. Новият план ще бъде незабавно достъпен за API.

Примерна заявка

curl https://api.tgmembership.com\
/bot1234567890\
/abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMN\
/addMember?plan_id=1
                    
Примерен отговор
{
  "ok":true,
  "code":200,
  "result":{
    "bot_username":"yourbotname",
    "access_token":"abcdefghijklmnopqrstuvwxyz",
    "link":"https:\/\/t.me\/yourbotname?start=accesstoken_abcdefghijklmnopqrstuvwxyz"
  }
}
GET /addMember 

Добавя нов участник.

 
ПараметърТипЗадължителен?Описание
plan_idIntegerДаID планът, който желаете да използвате за този код за достъп.

Използвайки този метод, Вие можете да създадете кодове за достъп, които по-късно могат да бъдат споделени с Вашите абонати. Когато се използва код за достъп, Вашият бот активира плана, който сте избрали при създаването на кода (параметър plan_id).

Примерна заявка

curl https://api.tgmembership.com\
/bot1234567890\
/abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMN\
/chatsGrowth?chat_id=-1000000000000&start_date=2021-03-01limit=3&order=ASC
                    
Примерен отговор
{
  "ok":true,
  "code":200,
  "result":{
    "-1000000000000":{
      "0":{
        "date":"2021-03-01",
        "members":"100"
      },
      "1":{
        "date":"2021-03-02",
        "members":"116"
      },
      "2":{
        "date":"2021-03-03",
        "members":"144"
      }
    }
  }
}
GET /chatsGrowth 

Следете растежа на своите чатове

 
ПараметърТипЗадължителен?Описание
chat_idIntegerНеФилтрирай отговора по Chat ID.
Ако липсва, всички резултати ще бъдат върнати.
start_dateStringНеФилтрирайте отговора по дата на запис. Използвайте формат YYYY-mm-dd. Например, 2021-03-01 (1-ви март 2021)
Ако липсва, всички резултати ще бъдат върнати.
limitIntegerНеЛимит на броят обекти, които заявката ще върне. Лимитът може да бъде в диапазона между 1 и 31.
Ако липсва, 7 резултати ще бъдат върнати.
orderEnumНеОбектите за всеки чат са сортирани по датата на тяхното записване. Вие можете да ги сортирате допълнително във възходящ или низходящ ред. DESC се използва по подразбиране.
Позволените стойности са:
ASC. Възходящ ред
DESC. Низходящ ред

Броят потребители във Вашите чатове се обновява веднъж дневно. Вашият бот следи броят потребители само в чатовете, които управлява. Ако желаете да добавите допълнителен чат, използвайте командата /addchat