API
Specjalnie dla naszych użytkowników, przygotowaliśmy specjalne "API" pozwalające na wyświetlenie informacji o kanałach na naszych stronach w prosty sposób.
To w jaki sposób dane te zostaną wykorzystane zależy tylko i wyłącznie od webmastera - i to właśnie on musi zadbać o odpowiednie przetworzenie tych danych. API jest wbrew pozorom bardzo proste. API wyświetla dane plaintextem, używając kodowania UTF-8. Wystarczy, pobrać dane z naszej strony:
http://pirc.pl/api/nazwa_kanalu/dane
Gdzie nazwa_kanalu to nazwa naszego kanału bez znaku #, a dane to jedna z poniższych funkcji:
- users - zwraca ilość użytkowników znajdujących się obecnie na kanale
- users-js - zwraca ilość użytkowników w document.write (do użycia w tagu <script>)
- topic - zwraca temat z podanego kanalu
- topic-js - temat w document.write (do użycia w tagu <script>)
- messages - zwraca ilość wysłanych na kanał wiadomości
- messages-js - zwraca ilość wiadomości w document.write (do użycia w tagu <script>)
- xml - zwraca wszystkie powyższe dane w formacie XML (zalecane)
- json - zwraca wszystkie dane w formacie JSON
Na przykład: http://pirc.pl/api/main/topic zwróci temat dla kanału #main.
Aby api zadziałało, nasz kanał nie może być ukryty (+s lub +p).
file_get_contents() w php. Przykładowy kod html będzie wyglądać następującokod PHP
<?
$users = file_get_contents('http://pirc.pl/api/main/users');
echo "Na moim kanale znajduje się obecnie ".$users." osób";
?>
Jeśli chcemy aby w temacie podanym na naszej stronie pojawiły się kolory, należy dodać nasz kod css do własnego stylu. Oto wspomniany kod: http://pirc.pl/css/colors.css. Nasz CSS definiuje klasy od .topic0 do .topic15 i od .topicbg0 do .topicbg15, dlatego do prawidłowego działania naszego CSSa, prosimy ich nie definiować. Oczywiście nic nie stoi na przeszkodzie, abyśmy ustawili kolory po swojemu.
<head> naszego kodu HTML:kod HTML
<link rel="stylesheet" href="http://pirc.pl/css/colors.css">