Jak rozpocząć pracę z API?

Sposób użycia

Aby korzystać z API konieczne jest posiadanie unikalnego identyfikatora API i tokenu.

Swój identyfikator znajdziecie Państwo w sekcji API w ustawieniach konta.

Identyfikator API zostanie wygenerowany dopiero po aktywacji konta.

Token jest ciągiem ośmiu pierwszych znaków z wyniku funkcji haszującej wykorzystującej algorytm SHA1. Argumentem funkcji będzie łańcuch znaków składający się z adresu e-mail oraz bieżącej daty w formacie "RRRR-MM-DD".

Adres e-mail musi być podany małymi literami.

Przykład

Załóżmy, że istnieje użytkownik Jan Zakupowy, którego unikalny identyfikator API to MjE5MA, a adres e-mail to janzakupowy@poczta.pl. Jan, chcąc skorzystać z API w dniu 18 marca 2015 r., będzie musiał wygenerować swój token za pomocą funkcji haszującej:

sha1(janzakupowy@poczta.pl2015-03-18)

Funkcja powinna zwrócić wartość BAE1360C.

Mając identyfikator API i token, Jan może wywołać funkcję hello, która zweryfikuje ich poprawność. W tym celu należy wysłać żądanie POST na adres:

https://www.fontannydomowe.pl/api/hello/

W jego treści należy podać dane do logowania:

api_key=MjE5MA&api_token=BAE1360C

W odpowiedzi Jan otrzyma plik XML o zawartości podobnej do poniższej:

<hello>
  <result>Hello Jan!</result>
</hello>

Jeśli identyfikator API lub token będą niepoprawne, Jan otrzyma plik XML o zawartości podobnej do poniższej:

<hello>
  <error description="Niepoprawny identyfikator API lub token">100</error>
</hello>