Skip to content
This repository has been archived by the owner on May 5, 2024. It is now read-only.

zhabbler/documentation_outdated

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 

Repository files navigation

Жабблерdocumentation

API документация Жабблера

Как вызвать функцию?

Чтобы вызвать функцию, необходимо перейти по URL адресу: https://zhabbler.ru/public_api/?type={НАЗВАНИЕ ФУНКЦИИ}.
К примеру, чтобы вызвать функцию GetAllPosts, необходимо перейти по этому URL: https://zhabbler.ru/public_api/?type=GetAllPosts.

Функции

Функции с постами

GetAllPosts

Нет параметров.
Функция для получения всех новых постов.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetAllPosts

[
  {
    "id":"833ddf021ed4618d0863f322610a4335de73bf352e1594932c10e16649d652f99469950b",
    "nickname":"zhabbler",
    "profile_pic_url":"{длинный url}",
    "title":"",
    "uploaded":"2023-09-12",
    "content":"Ква.",
    "likes":14
  }
]

GetPostsByNickname

Параметры: nickname.
Функция для получения всех постов от пользователя.
В параметре nickname необходимо ввести никнейм пользователя.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetPostsByNickname&nickname=zhabbler

[
  {
    "id":"833ddf021ed4618d0863f322610a4335de73bf352e1594932c10e16649d652f99469950b",
    "nickname":"zhabbler",
    "profile_pic_url":"{длинный url}",
    "title":"",
    "uploaded":"2023-09-12",
    "content":"Ква.",
    "likes":14
  }
]

GetRepost

Параметры: id.
Функция для получения всех репостов с поста.
В параметре id необходимо ввести id поста.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetRepost&id=0878995fc083195f1eb6bd94f87a00f5b8d046479b6c5928e0c52942f738040fa71b4e65

[
  {
    "id":"55a138cdb14a75ec38d5c8b16b9273ae18dcd6591335942758232eb32febea7f3550d219",
    "repostTo":"0878995fc083195f1eb6bd94f87a00f5b8d046479b6c5928e0c52942f738040fa71b4e65",
    "nickname":"zhabbler",
    "profile_pic_url":"{длинный url}",
    "title":"",
    "uploaded":"2024-01-01",
    "content":"Команда Жабблера поздравляет вас с Новым годом!<br>Желаем вам счастья, больше радости в жизни, и чтобы вы больше тратили времени на себя и на своё любимое хобби.<br>С Новым годом!",
    "likes":2
  }
]

GetPost

Параметры: id.
Функция для получения информации поста.
В параметре id необходимо ввести id поста.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetPost&id=833ddf021ed4618d0863f322610a4335de73bf352e1594932c10e16649d652f99469950b

[
  {
    "id":"833ddf021ed4618d0863f322610a4335de73bf352e1594932c10e16649d652f99469950b",
    "nickname":"zhabbler",
    "profile_pic_url":"{длинный url}",
    "title":"",
    "uploaded":"2023-09-12",
    "content":"Ква.",
    "likes":14
  }
]

CheckLike

Параметры: id, authCode.
Функция для проверки если пользователь поставил лайк в посте.
В параметре id необходимо ввести id поста.
В параметре authCode необходимо ввести аутентификационный код пользователя.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=CheckLike&id={id поста}&authCode={аутентификационный код}

[
  {
    "liked":1,
    "post_id":"{id поста}"
  }
]

Параметр liked будет выдавать 0 если пользователь не поставил лайк в посте.

GetPostsPhotos

Внимание! Скоро данная функция будет отключена.
Параметры:id
Функция для получения фотографий из поста.
В параметре id необходимо ввести id поста.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetPostsPhotos&id=aaa47d4731681282041d5abb3d86e4029cc6a857642ea9640e639d2463e402fd6fa3cdde

[
  {
    "url":"{длинный url}",
    "post_id":"aaa47d4731681282041d5abb3d86e4029cc6a857642ea9640e639d2463e402fd6fa3cdde"
  },
  {
    "url":"{длинный url}",
    "post_id":"aaa47d4731681282041d5abb3d86e4029cc6a857642ea9640e639d2463e402fd6fa3cdde"
  }
]

Функции с комментариями

GetComments

Параметры:id
Функция для получения комментариев из поста.
В параметре id необходимо ввести id поста.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetComments&id=aaa47d4731681282041d5abb3d86e4029cc6a857642ea9640e639d2463e402fd6fa3cdde

[
  {
    "nickname":"nickname",
    "profile_pic_url":"{длинный url}",
    "content":"Превосходно."
  }
]

Функции с пользователями

Необходимо об этом знать!

Когда пользователь входит в свой аккаунт, у него автоматически генерируется аутентификационный код (authCode) который позволяет делать с ним всё что угодно. Большинство функций которые будут даны ниже, будут требовать этот самый код.

GenerateAuthCode

Параметры:email, password
Функция для генерации аутентификационного кода (authCode).
В параметре email необходимо ввести email.
В параметре password необходимо ввести пароль.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GenerateAuthCode&email=********&password=**********

[
  {
    "error":null,
    "authCode":"{аутентификационный код}"
  }
]

Поле error будет выдавать ошибку, если что-то пошло не так.

GetUserByAuthCode

Параметры:authCode
Функция для проверки существования аутентификационного кода и получения данных профиля.
В параметре authCode необходимо ввести аутентификационный код.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetUserByAuthCode&authCode={аутентификационный код}

[
  {
    "exists":1,
    "name":"ярослав",
    "nickname":"flydelick",
    "profile_picture":"{длинный url}",
    "profile_cover":"{длинный url}"
  }
]

Поле exists будет выдавать 0, если аутентификационного кода не существует.

GetUserByNickname

Параметры:nickname
Функция для проверки существования аутентификационного кода и получения данных профиля.
В параметре nickname необходимо ввести никнейм пользователя.
Пример ответа по URL:https://zhabbler.ru/public_api/?type=GetUserByNickname&nickname=flydelick

[
  {
    "exists":1,
    "name":"ярослав",
    "nickname":"flydelick",
    "profile_picture":"{длинный url}",
    "profile_cover":"{длинный url}",
    "biography":"",
    "birth":"2009-01-05"
  }
]

Поле exists будет выдавать 0, если пользователя не существует.

About

API документация Жабблера

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published