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:

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).

Bardzo prostym sposobem wykorzystania API na swojej stronie może być funkcja file_get_contents() w php. Przykładowy kod html będzie wyglądać następująco

kod PHP

<?
    $users = file_get_contents('http://pirc.pl/api/main/users');
    echo "Na moim kanale znajduje się obecnie ".$users." osób";
?>

Jeśli możliwość edytowania kodu strony jest ograniczona (na przykład na blogu), można wykorzystać obrazek:

kod HTML

Na moim kanale jest teraz <img src="http://pirc.pl/api/main/users-png/00FFFF" alt="users"> użytkowników.

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.

Aby umieścić nasz CSS na swojej stronie, należy dodać następujący kod w sekcję <head> naszego kodu HTML:

kod HTML

<link rel="stylesheet" href="http://pirc.pl/css/colors.css">

Strona główna

Strona główna - Krótki opis sieci i podstawowe informacje na jej temat.

Bramka

Bramka - Specjalny interfejs WWW umożliwiająca ircowanie z przeglądarki, bez konieczności instalowania dodatkowego oprogramowania.

Informacje

Regulamin - zbiór zasad których użytkownicy PIRC.PL są zobowiązani przestrzegać.

Prace - informacje na temat prac, które administratorzy sieci aktualnie wykonują. W tym miejscu będą również zamieszczane wszelkie ważniejsze ogłoszenia.

I:Line - informacje dla administratorów serwerów shell, akademików, sieci osiedlowych i każdego innego miejsca, które wymaga połączenia do naszej sieci więcej osób z jednego adresu IP.

SSL - informacje dla osób chcących połączyć się z naszą siecią korzystając z bezpiecznego połączenia SSL.

Tor i proxy - informacje dla osób próbujących połączyć się z naszą siecią z serwerów TOR i PROXY.

Pomoc administracji - dodatkowa pomoc w pilnowaniu porządku na naszym kanale.

API - opis naszego modułu do wyświetlania statystyk kanału na własnej stronie WWW.

Bannery - generowane przez naszą stronę banery z informacjami o kanałach.

Logo - informacje na temat naszego logo

O nas - nieco więcej informacji na temat sieci i nas, administratorów, oraz krótka historia powstania tego miejsca.

Polecane - mała reklama - strony które sieć PIRC.PL poleca użytkownikom.

Serwisy

NickServ - rejestracja nicków.

ChanServ - rejestracja kanałów.

BotServ - postawienie na swoim kanale bota.

HostServ - ukrywanie swojego adresu IP.

MemoServ - wiadomości do niezalogowanych użytkowników.

Pomoc

Podstawy - miejsce od którego każdy początkujący powinien zacząć. Zbiór podstawowych pojęć i informacji które powinieneś posiadać.

Kanały - informacje na temat zarządzania kanałami i opis ich ustawień,

Użytkownicy - informacje na temat interakcji serwera z użytkownikiem i opis ustawień, które każdy może sobie nałożyć,

Konwersja kodowania - opis naszego autorskiego modułu do konwersji kodowania.

Częste problemy - czyli FAQ, odpowiedzi na często zadawane przez użytkowników pytania.

Statystyki

Podsumowanie - generalne informacje na temat wykorzystania sieci.

Wykresy - graficzna reprezentacja ilości użytkowników i kanałów w przedziale czasu.

Lista kanałów - lista największych kanałów na sieci.

Statystyki kanałów - strona pozwalająca obejrzeć informacje dotyczące poszczególnych kanałów.

Kontakt

Kontakt - alternatywna droga kontaktu z administracją.