DOKUMENTACJA INTERFEJSU API - HTTPS WERSJA 0.1 DATA PUBLIKACJI : 01.03.2014

SPIS TREŚCI

Spis treści Wprowadzenie_________________________________________________________________________________________ 1 Dostęp do usługi notowania online __________________________________________________________________ 2 Opis struktur danych __________________________________________________________________________________ 3 Kody błędów ___________________________________________________________________________________________ 5 Historia wersji _________________________________________________________________________________________ 6

WPROWADZENIE

Wprowadzenie ROZPOCZĘCIE WSPÓŁPRACY Aby rozpocząć współpracę z systemem kwotowań na platformie notowaniafx.pl. należy w pierwszej kolejności zarejestrować się korzystając z formularza umieszczonego na stronie http://www.notowaniafx.pl/rejestracja.html. Po poprawnej rejestracji, aby system mógł rozpocząć współpracę, wymagane jest podanie danych szczegółowych. Następnie, po poprawnym podaniu danych, można zakupić usługę kwotowań korzystając z panelu zarządzania usługami. Po zamówieniu usługi i dokonaniu płatności platforma przydzieli: • •

odpowiedni identyfikator usługi, który posłuży w celu wymiany danych odpowiednią nazwę użytkownika i hasło do usługi

FILTRY IP Z uwagi na dedykowane usługi na wybrany adres IP, system notowaniafx dokonuje odpowiedniej filtracji adresów IP, które mogą mieć dostęp do wybranej usługi. Adres ten można zmieniać w konfiguracji usługi.

POBRANIE HASŁA DO USŁUGI W panelu zarządzającym usługami platformy notowaniafx użytkownicy mogą pobrać wygenerowane dane autoryzacyjne przez system. Dane te są nadawane przez system i są unikalne względem użytkownika.

Strona 1

DOSTĘP DO USŁUGI NOTOWANIA ONLINE

Dostęp do usługi notowania online DOSTĘP HTTPS Dostęp do usługi wymiany danych kwotowań odbywa się za pomocą szyfrowanej wersji protokołu HTTP czyli HTTPS. Aby otrzymać dostęp do danych kwotowań należy w panelu usług pobrać informację na temat dostępów. Każda usługa wymiany danych udostępnia dane w trzech formatach danych : • • •

XML - Extensible Markup Language CSV - Comma Separated Values JSON - JavaScript Object Notation

ZASADA BUDOWY ADRESÓW URL Każda usługa w systemie notowaniafx posiada unikalny adres, za pomocą którego mogą Państwo osiągnąć dostęp do wygenerowanych danych kwotowań forex https://[nazwa_uzytkownika]:[haslo_dostepu]@notowaniafx.pl/userdata/[id-konteneraużytkownika]/[id-usługi].[format-danych]

PARAMETRY BUDOWANIA ADRESU URL NAZWA POLA NAZWA-UŻYTKOWNIKA HASŁO-DOSTĘPU ID-KONTENERA-UŻYTKOWNIKA ID-USLUGI FORMAT-DANYCH

Strona 2

OPIS POLA Nazwa użytkownika pobrana z platformy Mój Panel ->Usługi -> Notowania online -> Informacje Nazwa użytkownika pobrana z platformy Mój Panel ->Usługi -> Notowania online -> Informacje To wygenerowany hash dla nazwy folderu pozwalający trzymać wszystkie dane dla usług dla danego użytkownika Nazwa użytkownika pobrana z platformy Mój Panel ->Usługi -> Notowania online -> Informacje Wybrany format danych : JSON, XML, CSV

OPIS STRUKTUR DANYCH

Opis struktur danych FORMAT XML 454 101.5040 101.5290 2014-03-02 23:41:22 101.5165 20 USDJPY

FORMAT JSON {"quote":{ "USDJPY":{ "id":454, "bid_lack":false, "ask_lack":false, "bid":"101.5040", "ask":"101.5290", "last_change":"2014-03-02 23:41:22", "mid_lack":false, "mid":"101.5165", "fk_quotes_instrument_id":20, "instrument_name":"USDJPY" } }}

Strona 3

OPIS STRUKTUR DANYCH OPIS PÓL OPIS PÓL DLA STRUKTUR DANYCH NAZWA POLA Id bid_lack

ask_lack

mid_lack

Bid Ask last_change

OPIS POLA Identyfikator Trend wzrostowy względem ostatniego notowania kursu BID, jeśli był osiągnięty wzrost to otrzymana wartość true w przeciwnym wypadku false Trend wzrostowy względem ostatniego notowania kursu ASK, jeśli był osiągnięty wzrost to otrzymana wartość true w przeciwnym wypadku false Trend wzrostowy względem ostatniego notowania kursu MID, jeśli był osiągnięty wzrost to otrzymana wartość true w przeciwnym wypadku false Pole przechowywujące wartość kursu BID dla danego instrumentu Pole przechowywujące wartość kursu ASK dla danego instrumentu Data kwotowania dla danego instrumentu

Mid fk_quotes_instrument_id Instrument_name

Strona 4

Identyfikator instrumentu Nazwa instrumentu

KODY BŁĘDÓW

Kody błędów Kody błędów usługi HTTPS są zgodne z protokołem http, w dokumencie przedstawiamy najczęstsze z nich.

KODY BŁĘDÓW USLUGI HTTPS KOD BŁĘDU

OPIS

200

Zawartość żądanego dokumentu (najczęściej odpowiedzi w komunikacji WWW Internet)

302

Znaleziono – żądany zasób jest chwilowo dostępny pod innym adresem a przyszłe odwołania do zasobu powinny być kierowane pod adres pierwotny

400

Nieprawidłowe zapytanie – żądanie nie może być obsłużone przez serwer z powodu błędnej składni zapytania

403

Zabroniony – serwer zrozumiał zapytanie lecz konfiguracja bezpieczeństwa zabrania mu zwrócić żądany zasób

404

Nie znaleziono – serwer nie odnalazł zasobu według podanego URL ani niczego co by wskazywało na istnienie takiego zasobu w przeszłości

500

Wewnętrzny błąd serwera – serwer napotkał niespodziewane trudności, które uniemożliwiły zrealizowanie żądania

502

Błąd bramy – serwer – spełniający rolę bramy lub pośrednika – otrzymał niepoprawną odpowiedź od serwera nadrzędnego i nie jest w stanie zrealizować żądania klienta

503

Usługa niedostępna – serwer nie jest w stanie w danej chwili zrealizować zapytania klienta ze względu na przeciążenie

Strona 5

zwracany

nagłówek

HISTORIA WERSJI

Historia wersji HISTORIA ZMIAN DLA WERSJI WERSJA

DATA WYKONANIA

OPIS FUNKCJONALNOŚCI

0.1

01-03-2014

Generowanie danych kwotowań do formatu JSON

0.1

01-03-2014

Generowanie danych kwotowań do formatuXML

0.1

01-03-2014

Generowanie danych kwotowań do formatu CSV

0.1

01-03-2014

Autoryzacja za pomocą HTTP_AUTH

0.1

01-03-2014

Filtracja po adresach IP

Strona 6

Strona 7