Ogólnie

Protokol ten umozliwia programowy dostep do wielu zasobow grono.net. Do dostepu wymagany jest klient HTTP zachowujacy stan (ciasteczka), oraz obslugujacy redirect'y. Logowanie powinno odbywac sie przy pomocy protokolu https, natomiast wykonywanie wszelkich komend - przy pomocy http. Program ma się łączyć z adresem (http|https)://api.grono.net. Wszystkie urle mają być zdefiniowane jako ścieżki zależne od mniejsca na które zostanie wykonany redirect.

Parametry przekazywane sa jako argumenty GET badz POST natomiast odpowiedzi zwracane sa w XML'u. Wszelkie ciagi znakow kodowane sa UTF-8.

Login

  • POST na: http://api.grono.net/pub/apilogin/
  • Parametry:
    • client - nazwa klienta
    • cliver - wersja klienta
    • lang - kod jezyku klienta (np 'pl', 'en')
    • login, password
    • premium - ustawione na 1 jeśli klient opłacił dodatkowy transfer, 0 jeśli nie opłacił
  • Zwrot: <status value="NR_BLEDU">OPIS_BLEDU</status><update value="1 LUB 0" url="http://api.grono.net/api/Gronosoft.exe "/><handle>IDENTYFIKATOR UŻYTKOWNIA</handle>

Zwrócony identyfikator użytkownika nadaje się do używania w kolejnych requestach do API. Jeśli w URL jest fragment LOGIN_OR_ID - wstawiamy tam otrzymaną wartość.

Jeśli spróbujemy zalogować się drugi raz, serwer zwróci odpowiedź postaci: 

<status value="0">TEKST_JUŻ_ZALOGOWANY</status><handle>IDENTYFIKATOR_UŻYTKOWNIKA</handle>

Nieprawidłowy XML

Powyższy response nie jest prawidłowym XML. Brakuje mu co najmniej xml-stanza (<?xml version=...) i elementu głównego. Niestety nie możemy tego poprawić, ze względu na program Gronzo, który nie potrafiłby bez aktualizacji poprawnie wczytać odpowiedzi.

Logout

GET lub POST na http://api.grono.net/api/logout/

Parametry zbędne. Zinwaliduje przesłane ciasteczka sesji, czyniąc je nieważnymi w dalszych requestach. Zwróci odpowiedź 204 No Content.

Numery błędow

  • 0 - operacja wykonana poprawnie
  • 1 - zla nazwa uzytkownika lub haslo
  • 2 - blad bazy danych
  • 3 - odmowa dostepu
  • 4 - błąd wewnętrzny, w opisie jest traceback (wyświetlany dla nas - nigdy dla userów)
  • 8 - limit uploadu wyczerpany
  • 9 - okresowy limit ilości fotek wyczerpany
  • 10 - maintenance galerii włączone, nie można uploadowac.

mogą się pojawić kolejne numery błędów.