Download pdf - NK API - Wprowadzenie

Transcript
Page 1: NK API - Wprowadzenie

NK APIWprowadzenie

Aplikacje i

GryStrony

(c) Marek Ziółkowski 2012

Page 2: NK API - Wprowadzenie

Platforma NK API

Co wchodzi w skład platformy?

● API OpenSocial - standard dla aplikacji społecznościowych● Dokumentacja - opis platformy wraz z przykładami● Blog - informacje o aktualizacjach platformy● Serwis wsparcia - rozwiązywanie problemów deweloperów● Aplikacje i Strony - zarządzanie swoimi aplikacjami i stronami● JIRA - obsługa procesu publikowania aplikacji

Page 3: NK API - Wprowadzenie

API zgodne z OpenSocial

● Standard dla „social software” takich jak np. portale społecznościowe

● Pierwsza wersja opracowana w 2007 przez Google i MySpace

● OpenSocial jest używany przez wiele portali na świecie takich jak: Hi5, Yahoo, Linkedin, Orkut, Ning, Mail.ru, StudiVZ i inne

● Standard OpenSocial oraz jego referencyjna platforma Shindig jest oprogramowaniem open source

Page 4: NK API - Wprowadzenie

Aplikacje vs Strony

Strony● Integracja na zewnętrznych

stronach i aplikacjach przy użyciu przycisku Zaloguj się z NK

● Oparte o OAuth 2.0● Dostępne dla każdego - nie jest

wymagana umowa● Wymagana zgoda użytkownika

Aplikacje● Osadzone na portalu nk.pl● Wymagana umowa● Podlegają audytowi poprawności

i bezpieczeństwa● Komunikacja przez API JS'owe

Page 5: NK API - Wprowadzenie

Aplikacje vs StronyAplikacje Strony

JS API TAK NIE

REST API TAK(wymagana specjalna umowa) TAK

Możliwość kopiowania danych użytkownika na inne serwery

NIE TAK(użytkownik wyraża na to zgodę)

Wymagana specjalna umowa TAK NIE(deweloper akceptuje regulamin)

Uwierzytelnianie i autoryzacja Zalogowany użytkownik na portalu

Zaloguj się z NK (OAuth 2.0)

Widoczność w katalogu TAK NIE

Page 6: NK API - Wprowadzenie

Funkcjonalności portalu nk.plAplikacje Strony

Wpisy - dodawanie w imieniu użytkownikaTAK

(wymagana każdorazowo zgody użytkownika - popup)

TAK(wymagana jednorazowa zgoda

użytkownika)

Dane użytkownika (imię, nazwisko, avatar, płeć, wiek)

TAK(możliwe do pobrania za pomocą

JavaScript'u, możliwość przetwarzania wyłącznie w przeglądarce użytkownika)

TAK(wymagana jednorazowa zgoda

użytkownika)

Dodatkowe dane użytkownika (e-mail, wiek, miejscowość, numer telefonu, data urodzenia)

NIETAK

(wymagana jednorazowa zgoda użytkownika)

Powiadomienia TAK NIE

Pobieranie zdjęć z galerii TAK TAK

Zapraszanie znajomych do aplikacji TAK NIE

Dodawanie zdjęć do galerii aplikacji TAK TAK

Płatności EuroGąbkami (waluta NK) TAK NIE

Powiązanie z Grupą TAK NIE

Page 7: NK API - Wprowadzenie

Aplikacje - dodawanie

1. Zgłoszenie chęci współpracy (http://developers.nk.pl/contact/)

2. Deweloper otrzymuje konto (uprawnienia) do stworzenia nowej aplikacji

3. Deweloper dodaje aplikację w systemie4. Integracja aplikacji OpenSocial'owej5. Deweloper wysyła aplikację do akceptacji

przez NK6. NK wykonuje audyt poprawności i

bezpieczeństwa7. Aplikacja jest publikowana w katalogu

Page 9: NK API - Wprowadzenie

Aplikacje - Gadget'y - widokiOpenSocial'owe gadgety mają możliwość uruchamiania się w wielu miejscach.Ta sama aplikacja może wyglądać i działać inaczej w zależności od tego gdzie jest wyświetlana.Na portalu nk.pl dostępne są dwa widoki:

Główna strona aplikacji Box w grupie

Maksymalny rozmiar: 780 x 838 600 x 680

Identyfikator: canvas groups.right

Page 10: NK API - Wprowadzenie

Aplikacje - parametryNazwa Nazwa aplikacji widoczna na portalu.

Dostawca Nazwa firmy/organizacji wydawcy tytułu.

Pełny opis Wyświetlany na stronie instalacji/opisu aplikacji np. http://nk.pl/gry-online/doom/opis oraz w lewej kolumnie w widoku po zainstalowaniu.

Krótki opis Wyświetlany w katalogu aplikacji, przy ikonie.

Adres aplikacji W zależności od typu aplikacji:● gadget - URL wskazuje na xml-owy plik z opisem gadget'u● flash - URL wskazuje na plik swf,● HTML - URL do strony, która będzie wyświetlona w IFRAME

Wysokość i Szerokość

Rozmiar okna z aplikacją w widoku canvas.Aplikacje szersze niż 780px będą prezentowane na innej niż zwykle stronie, która jest dedykowana dla szerokich aplikacji. Rekomendowany rozmiar to 760px.

Typ ● Gadget - pozwala uzyskać dostęp do API; zdefiniowany przez plik XML● FLASH - aplikacja flash'owa bez dostępu do api; sam plik SWF (niedostępne)● HTML - link do strony, która będzie osadzona jako IFRAME; bez dostępu do API

(niedostępne)

Kategoria GAME lub APPLICATION - mają wpływ na widoczność w odpowiedniej kategorii katalogu oraz na komunikaty dla użytkowników (zagraj / uruchom)

Page 11: NK API - Wprowadzenie

Aplikacje - parametryAdres do obrazka Główna ikona aplikacji w rozmiarze 100x100.

Adres dużego obrazka Duży obrazek prezentowany w rozmiarze 400x300 na stronie instalacji/opisu aplikacji.

Adresy screenshot'ów Zrzuty ekranu z aplikacji - obsługiwane do 4 obrazków w proporcjach 4:3.

Identyfikator grupy ID grupy powiązanej z aplikacją. Po podaniu ID grupy, będzie można na niej umieścić aplikację (widok: groups.right).

Adres do obrazka promującego na grupie

Zaślepka w grupie widoczna, gdy użytkownik nie jest jej członkiem.

Adres do obsługi żądań o deinstalację aplikacji

Adres pod który NK będzie wysyłać żądania z informacjami o użytkownikach, którzy odinstalowali Twoją aplikację.

Ukrywanie Jeżeli zaznaczone, wtedy użytkownik może wybrać, czy jego aktywności w tej aplikacji będą widoczne przez znajomych. W przeciwnym wypadku użytkownik nie będzie miał takiego wyboru.

Ukryj "Grających Znajomych"

Jeżeli zaznaczone, ukrywa okienko z grającymi znajomymi na stronie aplikacji.

Ukryj Galerię Aplikacji Jeżeli zaznaczone, użytkownik nie będzie mógł oglądać galerii aplikacji.

Page 12: NK API - Wprowadzenie

Aplikacje - parametryMinimalny Wymagany Wiek Użytkownika

Minimalny wiek użytkownika, któremu pokazujemy aplikację w katalogu.

Maksymalny Wymagany Wiek Użytkownika:

Maksymalny wiek użytkownika, któremu pokazujemy aplikację w katalogu.

Tryb Debug Kiedy tryb debug jest włączony, cache jest wyłączony a tryb javascript-a jest ustawiany na debug (bez kompresji). Aplikacja dostępna publicznie nie może mieć ustawionego trybu debug.

Page 13: NK API - Wprowadzenie

Aplikacje - audyt poprawności i bezpieczeństwa

● Audyt to nie testy funkcjonalne● Najważniejsze, czy:

○ Aplikacja uruchamia się, ma opis i niezbędne grafiki○ Aplikacja nie przesyła danych użytkownika na swoje lub inne

serwery○ Aplikacja ma odpowiednie zabezpieczenia przed atakami np. XSS○ Tryb osadzenia flash'a to TRANSPARENT lub OPAQUE○ Rozmiary widoków są poprawne

Szablon audytu


Recommended