API Grono.net
Dostęp z aplikacji zewnętrznej do danych i funkcji Grono.net
Autoryzacja do Grono.net
Aby korzystać z gronowego api należy znać login i hasło użytkownika zarejestrowanego w serwisie (jest to ten sam login i hasło, które służy do autoryzacji w grono.net).- Login
- Login użytkownika, który będzie wykonywał akcje na gronie przez api
- Hasło
- Hasło użytkownika, który będzie wykonywał akcje na gronie przez api
Poniżej znajdują się wszystkie funckje udostępniane przez api Grona.
- Autoryzacja w grono.net
-
Odpowiedzią serwera jest klucz (___cook) użytkownika, dzięki któremu będzie można wykonywać akcje dostępnie wyłącznie dla zalogowanych.
Na adres http://grono.net.pl/api2/login/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagane login String Login użytkownika Wymagane password String Hasło użytkownika Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. - Ustawianie statusu użytkownika
-
Na adres http://grono.net.pl/api2/status/set/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagane status String Status, jaki ma być ustawiony użytkownikowi Wymagane ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. - Pobieranie statusu użytkownika
-
Na adres http://grono.net.pl/api2/status/get/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagany ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. - Pobieranie id użytkownika
-
Na adres http://grono.net.pl/api2/user/myid/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagany ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. - Pobieranie listy przyjaciół danego użytkownika
-
Na adres http://grono.net.pl/api2/friend/list/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagany ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. Odpowiedzią serwera jest lista przyjaciół. Każdy przyjaciel jest opisany przez:
- scrname
- nick użytkownika
- avatar_url
- adres portretu użytkownika
- online
- (true, false) - status zalogowania
- id
- id użytkownika
- sex
- (M lub K) płeć użytkownika
- Pobieranie informacji na temat danego użytkownika
-
Na adres http://grono.net.pl/api2/user/info/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagany ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Wymagany id Int Id użytkownika, którego dane chcemy pobrać. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. W odpowiedzi, serwer zwraca nstępujące dane:
- scrname
- nick użytkownika
- age
- wiek użytkownika
- name
- imię użytkownika (pokazywane jeśli ustawione)
- sex
- płeć użytkownika (M - mężczyzna, K - kobieta)
- motto
- motto użytkownika (pokazywane jeśli ustawione)
- surname
- nazwisko (pokazywane, gdy jest niepuste i widoczność jest ustawiona dla wszystkich w gronie)
- city
- nazwa miasta (pokazywane, gdy jest niepuste i widoczność jest ustawiona dla wszystkich w gronie)
- aboutme
- "O mnie" (pokazywane, gdy jest niepuste i widoczność jest ustawiona dla wszystkich w gronie)
- avatar_url
- adres portretu użytkownika
Wykorzystując klucz jednego użytkownika można wywoływać funkcję 100 razy na minutę.
- Wysyłanie shouta
-
Na adres http://grono.net.pl/api2/shout/send/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagany title String Tytuł shouta. Opcjonalny description String Opis shouta. Opcjonalny url String Adres, pod który jest podlinkowany tytuł shouta. Opcjonalny photo_url String Bezwzględny adres do fotki. Adres powinien być zapisany w kodowaniu procentowym. Wymagany ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. Wykorzystując klucz jednego użytkownika można wywoływać funkcję 5 razy na minutę.
- Wysyłanie wiadomości do przyjaciela
-
Na adres http://grono.net.pl/api2/message/send/, metodą POST lub GET należy wysłać następujące parametry:
Opcjonalny/Wymagany Nazwa Typ Opis Wymagany to String Id przyjaciela, do którego chcemy wysłać wiadmość. Wymagany subject String Tytuł wiadomości. Wymagany body String Treść wiadmości. Wymagany ___cook String Klucz, który serwer zrócił w momencie autoryzacji. Opcjonalny format XML lub JSON (default) Określenie formatu odpowiedzi serwera. Moze być JSON lub XML. Wykorzystując klucz jednego użytkownika można wywoływać funkcję 5 razy na minutę. Wiadomość można wysyłać wyłącznie do przyjaciół