API w GG

Jak zacząć?

Poniżej znajdują się dokładne opisy czynności w zależności od tego jak ma działać aplikacja:

Czym jest aplikacja na platformie GGAPI?

Platformę GGAPI można integrować:

  • na własnej stronie WWW
  • pisząc aplikacje działające w komunikatorze Gadu-Gadu dostępnym na różnych platformach.

W zależności od konfiguracji jedna aplikacja może działać na komunikatorach:

Aplikacje na platformie GGAPI oparte są o język HTML5, a więc aplikacją może być dowolna strona WWW jak również zbiór plików html wykorzystujących język JavaScript.

Tworzenie aplikacji w 3 krokach

Rejestracja aplikacji

Aby zarejestrować nową aplikację należy zalogować się na portalu dla developerów dev.gg.pl.

  • Stwórz nowego producenta:
    • Podaj nazwę, dane kontaktowe i opcjonalny opis i logo.
    • Nad jedną aplikacją może pracować kilka osób - wystaczy podać ich numery GG w odpowiednim polu formularza - te osoby też będą miały dostęp do konfiguracji aplikacji na stronie dev.gg.pl.
  • Stwórz nową aplikację:
    • W formularzu aplikacji należy podać identyfikator (nazwę skróconą aplikacji).
    • Dla podanego identyfikatora zostaną wygenerowane unikalne klucze client_id oraz client_secret używane do autoryzacji aplikacji.

Kod aplikacji

Posiadając klucze autoryzacyjne możesz już napisać kod aplikacji wykorzystując bibliotekę GGAPI JavaScript, GGAPI PHP lub dowolny inny język programowania implementując GGAPI REST. Należy przygotować ikonę aplikacji w formie pliku PNG o rozmiarach 128x128px

Zapisanie konfiguracji

Gdy aplikacja jest już gotowa, należy przygotować plik konfiguracyjny w paczce zip:

  • manifest.json w którym określisz jej numer wersji, nazwę, opis, zasoby użytkownika z których aplikacja korzysta oraz odpowiednie linki do aplikacji w zależności od platformy komunikatora.
  • ikonę aplikacji

Paczkę ZIP zawierającą pliki konfiguracyjne należy wgrać na stronie edycji aplikacji w serwisie dev.gg.pl

Działanie aplikacji

Po wejściu na stronę 

http://www.gg.pl/#apps/<identyfikator aplikacji>

następuje instalacja aplikacji.

Do wklejenia na stronę WWW

Wszelkie uwagi prosimy zgłaszać na forum lub na adres dev@gadu-gadu.pl. Jesteśmy otwarci na komentarze i chętnie przedyskutujemy każdą propozycję wprowadzenia zmian i ulepszeń. Architektura intefejsu programistycznego GGAPI wykonana jest zgodnie ze wskazaniami stylu REST.