Specyfikacja API

1. Wstęp

Z myślą o rozwoju Wstaw.Info przygotowałem dla was interfejs programistyczny (API). Pozwoli on na rozszeżenie możliwości serwisu o nowe aplikacje Webowe oraz systemowe. Staram się aby tworzenie wszelakiego rodzaju widgetów, aplikacji czy skryptów przy użyciu Wstaw API było jak najłatwiejsze dlatego czekam na wasze sugestie pod adresem wstaw@wstaw.info. Wstaw API jest ciągle rozwijane dlatego niedługo znajdziecie tutaj więcej opcji.

2. Warunki użytkowania

Rezerwuję sobie prawo do wyłączenia części lub całości API, blokowania użytkowników bez podawania przyczyn i dowolnej modyfikacji zasad dostępu oraz wprowadzania ograniczeń, przede wszystkim z powodu nadużyć różnej formy.

3. Zapytania API

Wstaw API oferuje gotowe zapytania, które mogą posłużyć do towrzenia aplikacji bądź widgetów. Poniżej mamy zaprezentowane zapytania API wraz z przykładami ich użycia.

3.1. Pobieranie czystego tekstu wpisu

To zapytanie do API pobiera nam wpis z serwisu w postaci czystego tekstu.

http://wstaw.info/api/txt/nr_wpisu

Przykładowo mamy wpis:

http://wstaw.info/42

zapytanie dla tego wpisu będzie wyglądało:

http://wstaw.info/api/txt/42

Odpowiedzią tego zapytania będzie czysty tekst w postaci:

Przykładowy tekst...

3.2. Pobranie tekstu jako skryptu JavaScript

Zapytanie pozwala nie wczytanie tekstu do kodu strony za pomocą JavaScript. Treść zapytania:

http://wstaw.info/api/js/42

Wykonanie tego zapytania da nam odpowiedź w postaci tekstu spreparowanego dla JavaScript:

document.write("Przykładowy tekst...");

Przykładowe zastosowanie:

<script src="http://wstaw.info/api/js/42" language="JavaScript" type="text/javascript">
</script>

Wykonanie powyrzszego skryptu spowowduje wyświetlenie tekstu w dokumencie o treści:

Przykładowy tekst...

3.3. Dodawanie wpisu

Wstaw API pozwala również na dodawanie wpisów. Wpisy można dodawać dwoma metodami - GET i POST. W obu przypadkach wynikiem zawsze jest nr wpisu.

3.3.1. Metoda GET

Dzięki tej metodzie możemy dodawać krótkie wpisy w bardzo łatwy sposób. Wystarczy wywołać odpowiedni adres URL. W odpowiedzi zostanie wyświetlony nr wpisu.

Zapytanie wygląda tak:

http://wstaw.info/api/add/get/tresc_wpisu

W tym zapytaniu można stosować specjalne znaczniki:

:n: - powoduje w pisie przejście do nowej lini
:s: - wstawiw w to miejsce znak przerwy (spację)

3.3.2. Metoda POST

Jest to idelna metoda do wstawiania dłuższych partii tekstu. Tekst powinien zostać przekazany metodą POST w zmiennej o nazwie "txt".

Treść zapytania:

http://wstaw.info/api/add/post/

W odpowiedzi otrzymamy tak jak w metodzie GET nr wpisu.

Jeśli nie zaznaczono inaczej, Zawartość tej strony dostępna jest na licencji Creative Commons Attribution-ShareAlike 3.0 License