NK API - Wprowadzenie

  • Published on
    22-May-2015

  • View
    2.667

  • Download
    4

Embed Size (px)

DESCRIPTION

Wprowadzenie do NK API.

Transcript

<ul><li> 1. NK APIWprowadzenieAplikacjeiStronyGry(c) Marek Zikowski 2012</li></ul> <p> 2. Platforma NK APICo wchodzi w skad platformy? API OpenSocial - standard dla aplikacji spoecznociowych Dokumentacja - opis platformy wraz z przykadami Blog - informacje o aktualizacjach platformy Serwis wsparcia - rozwizywanie problemw deweloperw Aplikacje i Strony - zarzdzanie swoimi aplikacjami i stronami JIRA - obsuga procesu publikowania aplikacji 3. API zgodne z OpenSocial Standard dla social software takich jaknp. portale spoecznociowe Pierwsza wersja opracowana w 2007 przez Google iMySpace OpenSocial jest uywany przez wiele portali na wiecietakich jak: Hi5, Yahoo, Linkedin, Orkut, Ning, Mail.ru,StudiVZ i inne Standard OpenSocial oraz jego referencyjna platformaShindig jest oprogramowaniem open source 4. Aplikacje vs StronyAplikacje Strony Osadzone na portalu nk.pl Integracja na zewntrznych Wymagana umowa stronach i aplikacjach przy Podlegaj audytowi poprawnoci uyciu przycisku Zaloguj si z i bezpieczestwa NK Komunikacja przez API JSowe Oparte o OAuth 2.0 Dostpne dla kadego - nie jestwymagana umowa Wymagana zgoda uytkownika 5. Aplikacje vs Strony Aplikacje StronyJS APITAKNIETAKREST API (wymagana specjalna umowa) TAKMoliwo kopiowania danych NIETAKuytkownika na inne serwery (uytkownik wyraa na to zgod)Wymagana specjalna umowaTAKNIE(deweloper akceptuje regulamin)Uwierzytelnianie i autoryzacjaZalogowany uytkownik na Zaloguj si z NK (OAuth 2.0)portaluWidoczno w katalogu TAKNIE 6. Funkcjonalnoci portalu nk.pl Aplikacje StronyTAKTAKWpisy - dodawanie w imieniu uytkownika(wymagana kadorazowo zgody(wymagana jednorazowa zgoda uytkownika - popup)uytkownika)TAK TAKDane uytkownika (imi, nazwisko, avatar,(moliwe do pobrania za pomoc(wymagana jednorazowa zgodape, wiek) JavaScriptu, moliwo przetwarzania uytkownika)wycznie w przegldarce uytkownika)Dodatkowe dane uytkownika (e-mail,TAKwiek, miejscowo, numer telefonu, data NIE (wymagana jednorazowa zgodaurodzenia) uytkownika)Powiadomienia TAKNIEPobieranie zdj z galeriiTAKTAKZapraszanie znajomych do aplikacjiTAKNIEDodawanie zdj do galerii aplikacjiTAKTAKPatnoci EuroGbkami (waluta NK) TAKNIEPowizanie z GrupTAKNIE 7. Aplikacje - dodawanie1. Zgoszenie chci wsppracy(http://developers.nk.pl/contact/)2. Deweloper otrzymuje konto (uprawnienia) do stworzenia nowej aplikacji3. Deweloper dodaje aplikacj w systemie4. Integracja aplikacji OpenSocialowej5. Deweloper wysya aplikacj do akceptacji przez NK6. NK wykonuje audyt poprawnoci i bezpieczestwa7. Aplikacja jest publikowana w katalogu 8. Strony - dodawanie1. Zalogowanie si do panelu zarzdzania Aplikacjami i Stronami2. Akceptacja regulaminu dla Zaloguj si z NK3. Dodanie strony do systemu4. Integracja strony przy uyciu OAuth 9. Aplikacje - Gadgety - widokiOpenSocialowe gadgety maj moliwo uruchamiania si w wielu miejscach.Ta sama aplikacja moe wyglda i dziaa inaczej w zalenoci od tego gdziejest wywietlana.Na portalu nk.pl dostpne s dwa widoki: Gwna strona Box w grupieaplikacji Maksymalny rozmiar: 780 x 838 600 x 680Identyfikator:canvasgroups.right 10. Aplikacje - parametryNazwa Nazwa aplikacji widoczna na portalu.DostawcaNazwa firmy/organizacji wydawcy tytuu.Peny opisWywietlany na stronie instalacji/opisu aplikacji np. http://nk.pl/gry-online/doom/opis oraz w lewejkolumnie w widoku po zainstalowaniu.Krtki opis Wywietlany w katalogu aplikacji, przy ikonie.Adres aplikacji W zalenoci od typu aplikacji: gadget - URL wskazuje na xml-owy plik z opisem gadgetu flash - URL wskazuje na plik swf, HTML - URL do strony, ktra bdzie wywietlona w IFRAMEWysoko iRozmiar okna z aplikacj w widoku canvas.Szeroko Aplikacje szersze ni 780px bd prezentowane na innej ni zwykle stronie, ktra jest dedykowanadla szerokich aplikacji. Rekomendowany rozmiar to 760px.Typ Gadget - pozwala uzyska dostp do API; zdefiniowany przez plik XMLFLASH - aplikacja flashowa bez dostpu do api; sam plik SWF (niedostpne)HTML - link do strony, ktra bdzie osadzona jako IFRAME; bez dostpu do API (niedostpne)Kategoria GAME lub APPLICATION - maj wpyw na widoczno w odpowiedniej kategorii katalogu oraz nakomunikaty dla uytkownikw (zagraj / uruchom) 11. Aplikacje - parametryAdres do obrazkaGwna ikona aplikacji w rozmiarze 100x100.Adres duego obrazkaDuy obrazek prezentowany w rozmiarze 400x300 na stronie instalacji/opisu aplikacji.Adresy screenshotwZrzuty ekranu z aplikacji - obsugiwane do 4 obrazkw w proporcjach 4:3.Identyfikator grupy ID grupy powizanej z aplikacj. Po podaniu ID grupy, bdzie mona na niej umieciaplikacj (widok: groups.right).Adres do obrazkaZalepka w grupie widoczna, gdy uytkownik nie jest jej czonkiem.promujcego na grupieAdres do obsugiAdres pod ktry NK bdzie wysya dania z informacjami o uytkownikach, ktrzyda o deinstalacjodinstalowali Twoj aplikacj.aplikacjiUkrywanie Jeeli zaznaczone, wtedy uytkownik moe wybra, czy jego aktywnoci w tej aplikacji bdwidoczne przez znajomych. W przeciwnym wypadku uytkownik nie bdzie mia takiegowyboru.Ukryj "GrajcychJeeli zaznaczone, ukrywa okienko z grajcymi znajomymi na stronie aplikacji.Znajomych"Ukryj Galeri Aplikacji Jeeli zaznaczone, uytkownik nie bdzie mg oglda galerii aplikacji. 12. Aplikacje - parametryMinimalny Wymagany Minimalny wiek uytkownika, ktremu pokazujemy aplikacj w katalogu.Wiek UytkownikaMaksymalny Maksymalny wiek uytkownika, ktremu pokazujemy aplikacj w katalogu.Wymagany WiekUytkownika:Tryb Debug Kiedy tryb debug jest wczony, cache jest wyczony a tryb javascript-a jest ustawiany na debug (bez kompresji). Aplikacja dostpna publicznie nie moe mie ustawionego trybu debug. 13. Aplikacje - audyt poprawnoci ibezpieczestwa Audyt to nie testy funkcjonalne Najwaniejsze, czy: Aplikacja uruchamia si, ma opis i niezbdne grafiki Aplikacja nie przesya danych uytkownika na swoje lub inneserwery Aplikacja ma odpowiednie zabezpieczenia przed atakami np. XSS Tryb osadzenia flasha to TRANSPARENT lub OPAQUE Rozmiary widokw s poprawneSzablon audytu</p>