~/paste/documentation
~/paste/documentation
~/paste/documentation
BulTux Pastebin • API

XML Изход

JSON Изход

API-то на тази страница предлага следните функции, които могат да бъдат извиквани с GET или POST заявки. Тази функция връща резултата в XML/JSON формат в зависимост от страницата на която е направена HTTP заявката.

API → Create
За да създадете нов запис, трябва да изпратите GET или POST заявка съдържаща определени параметри до http://paste.bultux.org/

Задължителни параметри
  • paste_data - Текстът, който да бъде записан
  • paste_lang - Използвания програмен език
  • api_submit - Задайте стойност true на този параметър
  • mode - Задайте xml или json за този параметър
Допълнителни параметри
  • paste_user - Име на автора от букви и цифри
  • paste_password - Парола, с която да бъде защитен записа
  • paste_private - Флаг за лична публикация, съдържаща стойности: yes или no
  • paste_expire - Време в секунди, след което записът ще бъде изтрит от сървъра. Задайте 0, за да забраните тази опция.
  • paste_project - Дали записа да бъде асоцииран с проект
За списък с поддържаните езикови кодове за paste_lang параметъра, виж http://paste.bultux.org/doc/lang.

Върнати стойности при успех
  • id - ID на записа
  • hash - Hash/ключ за записа (само за лични записи)
Връзките могат да бъдат комбинирани като http://paste.bultux.org/<id> за публични записи или http://paste.bultux.org/<id>/<hash> за лични записи.

Върнати стйности при грешка
Параматър error с един от тези кодове за грешка бива върнат:
  • err_nothing_to_do - Когато не е получена POST заявка от create API
  • err_author_numeric - Името на автора на записа трябва да бъде букви и цифри
  • err_save_error - Оказва, че е възникнала грешка при запазването на записа

API → Show
API-функцията show слуша за двете GET и POST заявки и връща XML/JSON данни. Въпреки, че можете да използвате и двата метода, за да извлечете информацията, силно препоръчваме използването на POST, когато изпращате парола към сървъра.

Можете да изпратите http GET заявката в следния формат: http://paste.bultux.org/api/<format>/<id>/<hash>/<password>.
Трябва да изпратите POST заявка до http://paste.bultux.org/show.php

Задължителни параметри
  • id - ID на записа
  • format - Форматът (xml или json) в който искате резултата
Допълнителни параметри
  • hash - Hash/ключ за записа (само за лични записи)
  • password - Парола за отключване на записа (само за защитени записи)
Върнати стойности при успех
  • id - ID на записа
  • author - Автор на записа
  • timestamp - UNIX timestamp представяща датата на създаване
  • language - Програмния език на записа
  • data - Информацията за записа
Върнати стйности при грешка
Параматър error с един от тези кодове за грешка бива върнат:
  • err_not_found - Записът не е открит
  • err_invalid_hash - Невалиден hash код
  • err_password_required - Необходима е парола, за да бъде видят записа
  • err_invalid_password - Зададена е грешна парола

API → List
API-метода list слуша за двете GET и POST заявки. Списък с параметрите е даден по-долу:

Задължителни параметри
  • format - Форматът (xml или json) в който искате резултата
Допълнителни параметри
  • project - Проект, към който принадлежи записа
  • page - Списък страницата, която да бъде хваната
Върнати стойности при успех
  • pastes - Съдържа под-елементи като paste1, paste2 etc., всеки от които има запис-ID
  • count - Броя на елементи в записа затворени в pastes
  • pages - Общ брой страници
Върнати стйности при грешка
Параматър error с един от тези кодове за грешка бива върнат:
  • err_no_pastes - Не са открити записи