TwitblitSDK - официальный документация

Описание

TwitblitSDK - это JavaScript SDK для работы с API социальной платформы Twitblit. Библиотека предоставляет удобные методы для взаимодействия с постами, комментариями и другими функциями платформы.

примеры:

https://gitflic.ru/project/twiblit-development/twitblitsdk-sample

Предупреждение

[!WARNING] twitblitsdk 0.0.1 больше не доступен из-за изменение версия и ссылку апи, так как v.1.2 больше не работает. Начинается с 0.0.2 в v2.0

[!WARNING] SDK работает пока только Node js, будущая будет доступен другие framework

Установка

npm install twitblitsdk или yarn add twitblitsdk

перед тем как начать работы

1. Api Key: Вам надо создать Mini Apps Twitblit, но настоящий момент пока страница для разработчик пока нет, для есть специальный форма обращение: Обратная связь

   1. Технические вопросы
   2. Сообщение писать нужно именно так: пример: https://twitblit.ru/tb/meteolive (где meteolive — ваш топик) и дальше запросить создать mini apps для бота или указать другие цели. Обязательно писать точно.

2. X-Token Вам надо зайти ваших профиль или главное страницу после авторизациии нужно открыть DevTools для получение токен (ВНИМАНИЕ: НЕ ВЫХОДИТЬ ИЗ АККАУНТ, А ИНАЧЕ ТОКЕН УДАЛЯЕТСЯ) вот пример:

Инициализация

import TwitblitAPI from 'twitblitsdk';
import { config } from './key.js';

const api = new TwitblitAPI(
  config.api_key,    // API ключ
  config.token,      // Токен доступа
  'ru.wfllive.meteo' // Идентификатор приложения
);

Методы API

Посты

1. Получить все посты

const allPosts = await api.posts.getAll(sort, page, perPage);

Параметры:

• sort - тип сортировки (‘new’, ‘popular’, ‘recommendations’, ‘subscriptions’)
• page - номер страницы - Количество постов на странице (1-100 для авторизованных, 1-30 для неавторизованных)
• perPage - количество постов на странице начинается с 1

2. Получить посты по теме

const topicPosts = await api.posts.getByTopic(topic, sort, page, perPage);

Параметры:

• topic - ваших topic (например ‘thunderstorm’)
• sort - тип сортировки - new (новые), popular (популярные)
• page - номер страницы
• perPage - количество постов на странице

3. Получить конкретный пост

const post = await api.posts.getById(postId);

Параметры:

• postId - ID поста

4. Создать пост

const newPost = await api.posts.create(topic, text, attachments);

Параметры:

• topic - ваших topic поста
• text - текст поста
• attachments - массив путей к файлам или URL изображений

5. Лайкнуть пост

const likeResult = await api.posts.like(postId);

Параметры:

• postId - ID поста

6. Удалить пост

const deleteResult = await api.posts.delete(topic, postId);

Параметры:

• topic - ваших topic
• postId - ID поста

Комментарии

1. Получить комментарии к посту

const comments = await api.comments.getByThread(postId, sort, page, perPage);

Параметры:

• postId - ID поста
• sort - тип сортировки (popular (по популярности) или new (по дате))
• page - номер страницы
• perPage - количество комментариев на странице

2. Создать комментарий

const newComment = await api.comments.create(
  postId,
  text,
  attachments,
  replyToId
);

Параметры:

• postId - ID поста
• text - текст комментария
• attachments - массив вложений (пути к файлам или URL)
• replyToId - ID комментария для ответа (опционально)

3. Лайкнуть комментарий

const likeResult = await api.comments.like(commentId);

Параметры:

• commentId - ID комментария

4. Удалить комментарий

const deleteResult = await api.comments.delete(commentId);

Параметры:

• commentId - ID комментария

Пример использования

export default async function Main() {
  try {
    // Получить 5 новых постов
    const allPosts = await api.posts.getAll('new', 1, 5);
    
    // Создать новый пост
    const newPost = await api.posts.create(
      'thunderstorm',
      'Тестовый пост',
      ['./image.jpg']
    );
    
    // Получить комментарии
    const comments = await api.comments.getByThread(newPost.data.id, 'new', 1, 5);
    
    // Создать комментарий
    await api.comments.create(
      newPost.data.id,
      'Тестовый комментарий',
      []
    );
    
  } catch (error) {
    console.error('Ошибка:', error.message);
  }
}

Ограничения

1. Для бесплатных аккаунтов:

   • Максимум 1 вложение в посты и комментарии

2. Для премиум аккаунтов:

   • До 5 вложений в посты и комментариях

Донат:

поддержка в проект: https://yoomoney.ru/to/410014823903442

Лицензия

MIT License

Copyright (c) 2025 Twitblit

Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации, безвозмездно использовать программное обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, объединение, публикацию, распространение, сублицензирование и/или продажу копий программного обеспечения.