Filmaster prezentuje API

Data:

Ci z Was bardziej zainteresowani tematem wiedzą to już od pewnego czasu, ale dopiero teraz możemy oficjalnie poinformować o wydaniu pierwszej publicznej wersji API programistycznego Filmastera. API pozwala programistom na komunikację z serwisem Filmaster.pl bez konieczności ręcznej interakcji w przeglądarce czy wykorzysywania przeróżnych hacków aby dobrać się do naszych treści.


Co znajdziecie w API?


Pierwsza wersja API jest od razu, jak mawia młodzież (a może już tak nie mówi?) full wypas. Umożliwia m.in:

- autoryzację za pomocą standardu OAuth (rejestracja i logowanie)

- autoryzacja Basic (użytkownik i hasło w HTTP) – nie zalecamy!

- dostęp do rekomendacji

- możliwość oceniania filmów

- wyszukiwanie filmów

- pobieranie i dodawanie danych recenzji (krótkich i długich) do filmów

- listowanie i dodawanie komentarzy

- dostęp do danych o tym kto kogo obserwuje, z możliwością dodania / usunięcia użytkownika z obserwowanych

- obsługa koszyków filmów (kolekcje użytkowników, listy życzeń)

- informacja o innych użytkownikach Filmastera – lista użytkowników najbliższych nam gustem oraz zlokalizowanych w naszej okolicy

- testowo: pobieranie informacji o repertuarze

- testowo: możliwość zapisywania się na konkretny seans (check-in) oraz sprawdzenia kto inny wybiera się w tym czasie do kina na ten sam seans


Technikalia


Api wykonane jest przy użyciu architektury REST – czyli używamy protokołu HTTP, zasoby identyfikowane są przez adresy URI, poszczególne operacje (odczytywanie, tworzenie, usuwanie, modyfikowanie) realizowane są za pomocą odpowiedniej operacji HTTP (GET, PUT/POST, DELETE), nośnikiem danych jest JSON. Adresy URI API zaczynają się od numeru wersji api, w tym przypadku prefiksu /1.0/


Jestem programistą. Co mogę zrobić z Waszym API?


Wiele! Udostępniamy prawie całą funkcjonalność serwisu, więc ograniczeniem jest tylko to co oferuje sam Filmaster.

Kilka pomysłów:

- Możesz napisać klienta Filmastera dla swojej platformy mobilnej. Oficjalne klienty powstają dla iPhone i Androida. Reszta platform czeka na niezależne implementacje.

- Możesz zintegrować swoją stronę filmową z Filmasterem: umożliwić ocenianie filmów i zaoferować użytkownikom rekomendacje, wyświetać recenzje i opinie użytkowników Filmastera przy opisach filmów, pokazywać rankingi.

- Możesz napisać aplikację filmową bądź stronę internetową korzystając z danych i funkcji które udostępniamy.


Przykłady wykorzystania API (już działające)


Mariusz Kryński napisał testową aplikację, która po podaniu listy znajomych z Filmastera listje filmy, których wspólnie nie widzieliście, a które powinny spodobać się wam wszystkim (idealne na imprezy!) – kod tej aplikacji możecie ściągnąć stąd: https://bitbucket.org/mrk/filmaster-api-sample



Z API Filmastera korzysta też serwis LubimyCzytać.pl który w sidebarze prezentuje najciekawsze recenzje z Filmastera.



Jeśli skorzystasz z API Filmastera, daj nam o tym znać mailowo na filmaster@filmaster.pl. Chętnie wypromujemy Twój projekt, jeśli zrobiłeś z API coś ciekawego!


Licencja i restrykcje


Wszystkie treści dodane przez użytkowników (opinie, recenzje) dostępne są na liberalnej licencji Creative Commons Uznanie Autorstwa. Możesz więc skorzystać z nich o ile zastosujesz się do wymagań tej licencji (więcej informacji).


Korzystanie z API jest obecnie bezpłatne i takie powinno pozostać dla większości zastosowań, choć zachowujemy sobie możliwość wprowadzenia opłat w przypadku intensywnego wykorzystywania API.


Przykładowo:



  • Jeśli masz bloga i chcesz wrzucić na niego widżet z ostatnio ocenionymi przez siebie filmami – nie ma problemu.

  • Jeśli planujesz zintegrować się z Filmasterem tworząc nową stronę filmową Onetu, napisz do nas najpierw na filmaster@filmaster.pl, żeby nie było zaskoczeń.

  • Jeśli chcesz stworzyć aplikację mobilną Filmastera, również się z nami skontaktuj, żeby się upewnić, że nie zmieniliśmy planów i nie tworzymy właśnie własnej aplikacji dla tej samej platformy. Oczywiście nie powinno być problemów i z dziesięcioma aplikacjami, ale lepiej zagadać, żeby potem się nie zdziwić.


Dokumentacja i support


Dokumentacja API (w język angielskim) dostępna jest na stronie: http://filmaster.org/display/DEV/API.

Osobą kontaktową w przypadku pytań związanych z API jest Mariusz Kryński, autor całego kodu. Najlepiej kontaktować się jednak z nami przed adres mailowy: dev@filmaster.pl. Na pewno pomożemy!