Zarejestruj się
BREEDER.PL - pomóżmy potrzebującym razem.

Twórcy aplikacji

Jako programista możesz tworzyć aplikacje i dodawać je do BREEDER.PL, wykorzystując istniejącą bazę użytkowników. Będąc gospodarzem aplikacji oznacza to, że ​​masz pełną kontrolę nad specyfikacją serwera.

Konfiguracja aplikacji

Podczas interakcji z BREEDER.PL Twoja aplikacja może wywoływać parametry naszych API oraz żądania lub wysyłać informacje.

Po dodaniu aplikacji na naszej stronie otrzymasz identyfikator APP.

Żądanie tokena

Jeżeli planujesz używać naszego API musisz najpierw poprosić o token. W celu złożenia wniosku o token będziesz potrzebować unikalnego klucza, który wyślemy do Ciebie gdy odwiedzisz aplikację z iframe na naszym portalu. Przekazujemy go jako $_GET['key'].
Tutaj jest jest przykład w jaki sposób można wystąpić o token:
http://breeder.pl/token.php?key=$_GET['key']
Jeżeli się powiedzie, otrzymasz odpowiedź JSON wyglądającą jak ta poniżej:
Object
(
    [token] => LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUc4d0RRWUpLb1pJaHZjTkFRRUJCUUFEWGdBd1d3SlVBdHFZdmVWOXFEdDd6NFhXTXYzS3VZM2JyWXpUKzR0VgpBbERrN1dQWjhqRVpoVzBNWjE1Z3lHdGNlNm5ueFRNenp4SXpHM29BRVIzc0JVRCtYdStHb21JeVV4UE1RN1NtCkVPdFg0ZTNwekp6R081cUxBZ01CQUFFPQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0K
)

Wysyłanie żądania

Teraz, gdy masz ważny token możesz zwracać się do naszego serwera. Wraz z każdym żądaniem należy przekazać token, który stworzyliśmy dla Ciebie.
Na przykład wezwanie naszego serwera API będzie wyglądać tak:
http://breeder.pl/api.php?token=#{TOKEN}&method=#{METHOD_NAME}

Zrozumienie odpowiedzi API

Dla metod, które mogą zwrócić więcej niż jedną pozycję, odpowiedź będzie zawierać ogólny dostępny wskaźnik jak również ile znajduje się stron. Zwracana domyślnie wartość to 10 pozycji. Aby uzyskać następne 10 elementów, musisz przekazać parametr "page=2".

Po lewej stronie znajduje się lista modułów, które implementują metody API. Kliknij na moduł, aby zobaczyć listę metod, które aplikacja może wykorzystywać.

friend
getFriends
GET /api.php?method=friend.getFriends&user_id=#{USER_ID}
Pobiera pełną listą znajomych dla konkretnego użytkownika. Jeśli nie pasuje #{USER_ID} przekażemy informacje o użytkowniku, który jest aktualnie zalogowany
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 1
            [pages] => 0
            [current_page] => 0
        )

    [output] => Array
        (
            [0] => Object
                (
                    [user_id] => 7
                    [user_name] => jane-doe
                    [full_name] => Jane Doe
                    [joined] => 1314110027
                    [country_iso] => US
                    [gender] => Female
                    [photo_50px] => http://breeder.pl/file/pic/user/7_50.jpg
                    [photo_50px_square] => http://breeder.pl/file/pic/user/7_50_square.jpg
                    [photo_120px] => http://breeder.pl/file/pic/user/7_120.jpg
                    [photo_original] => http://breeder.pl/file/pic/user/7.jpg
                    [profile_url] => http://breeder.pl/index.php?do=/jane-doe/
                )

        )

)
isFriend
GET /api.php?method=friend.isFriend&user_id=#{USER_ID}&friend_user_id=#{FRIEND_USER_ID}
Sprawdza, czy 2 użytkownicy są znajomymi, czy nie. Jeśli nie pasuje #{USER_ID} przekażemy informacje o użytkowniku, który jest aktualnie zalogowany.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Object
        (
            [is_friend] => 1
        )

)
mail
getNewCount
GET /api.php?method=mail.getNewCount&user_id=#{USER_ID}
Pobierz całkowitą ilość niewidzianych wiadomości. Jeżeli nie wybierzesz #{USER_ID}, zwrócona zostanie informacja dla żytkownika, który jest aktualnie zalogowany.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => 1
)
notification
getNewCount
GET /api.php?method=notification.getNewCount&user_id=#{USER_ID}
Ilość nieobejrzanych powiadomień użytkownika. Jeśli nie znasz #{USER_ID}, zwrócimy informacje o użytkowniku, który jest aktualnie zalogowany.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 5
            [pages] => 0
            [current_page] => 0
        )

    [output] => 5
)
get
GET /api.php?method=notification.get&user_id=#{USER_ID}
Ilość powiadomień użytkownika. Jeśli nie znasz #{USER_ID}, zwrócimy informacje o użytkowniku, który jest aktualnie zalogowany.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Array
        (
            [0] => Object
                (
                    [notification_id] => 3
                    [link] => http://breeder.pl/john-doe/comment-id_1/
                    [message] => Jane Doe commented on your wall
                    [icon] => http://breeder.pl/module/blog/static/image/default/default/activity.png
                )

        )

)
photo
addPhoto
POST /api.php?method=photo.addPhoto&photo=#{@FILE_PATH;TYPE=MIME_TYPE}&photo_name=#{BASE_FILE_NAME}
Uploads a photo on behalf of the user.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Object
        (
            [original] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d.jpg
            [75px] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_75.jpg
            [100px] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_100.jpg
            [150px] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_150.jpg
            [240px] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_240.jpg
            [500px] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_500.jpg
            [1024px] => http://breeder.pl/file/pic/photo/2011/08/39740c5e356fdd6f66cfc973d4aebf6d_1024.jpg
        )

)
getPhotos
GET /api.php?method=photo.getPhotos&user_id=#{USER_ID}
Pobierz wszystkie zdjęcia tego użytkownika. Jeżeli nie wybrałeś #{USER_ID}, zwrócona zostanie informacja o użytkowniku, który jest aktualnie zalogowany.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 1
            [pages] => 0
            [current_page] => 0
        )

    [output] => Array
        (
            [0] => Object
                (
                    [photo_100px] => http://breeder.pl/file/pic/photo/c81e728d9d4c2f636f067f89cc14862c_100.jpg
                    [photo_240px] => http://breeder.pl/file/pic/photo/c81e728d9d4c2f636f067f89cc14862c_240.jpg
                    [photo_original] => http://breeder.pl/file/pic/photo/c81e728d9d4c2f636f067f89cc14862c.jpg
                )

        )

)
user
getUser
GET /api.php?method=user.getUser&user_id=#{USER_ID}
Pobierz informacje dla użytkownika o numerze ID#. Jeżeli nie wybierzesz #{USER_ID}, otrzymasz zwrotnie informacje o obecnie zalogowanym użytkowniku.
Odpowiedź
Object
(
    [api] => Object
        (
            [total] => 0
            [pages] => 0
            [current_page] => 0
        )

    [output] => Object
        (
            [user_id] => 1
            [user_name] => john-doe
            [joined] => 1314109907
            [gender] => Male
            [country_iso] => US
            [full_name] => John Doe
            [email] => john.doe@site.com
            [photo_50px] => http://breeder.pl/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e_50.jpg
            [photo_50px_square] => http://breeder.pl/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e_50_square.jpg
            [photo_120px] => http://breeder.pl/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e_120.jpg
            [photo_original] => http://breeder.pl/file/pic/user/2011/08/9d673759d1cf55c9cd0b0805dc32e68e.jpg
            [profile_url] => http://breeder.pl/index.php?do=/john-doe/
        )

)