DOKUMENTACJA INTERFEJSU API - HTTPS

Transkrypt

1 DOKUMENTACJA INTERFEJSU API - HTTPS WERSJA 0.1 DATA PUBLIKACJI :

2 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

3 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 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

4 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 PARAMETRY BUDOWANIA ADRESU URL NAZWA POLA NAZWA-UŻYTKOWNIKA HASŁO-DOSTĘPU ID-KONTENERA-UŻYTKOWNIKA ID-USLUGI FORMAT-DANYCH 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 Strona 2

5 OPIS STRUKTUR DANYCH Opis struktur danych FORMAT XML <quotes> <quote> <USDJPY> <id>454</id> <bid_lack/> <ask_lack/> <bid> </bid> <ask> </ask> <last_change> :41:22</last_change> <mid_lack/> <mid> </mid> <fk_quotes_instrument_id>20</fk_quotes_instrument_id> <instrument_name>usdjpy</instrument_name> </USDJPY> <quote> </quotes> FORMAT JSON {"quote":{ "USDJPY":{ "id":454, "bid_lack":false, "ask_lack":false, "bid":" ", "ask":" ", "last_change":" :41:22", "mid_lack":false, "mid":" ", "fk_quotes_instrument_id":20, "instrument_name":"usdjpy" } }} Strona 3

6 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 Identyfikator instrumentu Nazwa instrumentu Strona 4

7 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 zwracany nagłówek 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

8 HISTORIA WERSJI Historia wersji HISTORIA ZMIAN DLA WERSJI WERSJA DATA WYKONANIA OPIS FUNKCJONALNOŚCI Generowanie danych kwotowań do formatu JSON Generowanie danych kwotowań do formatuxml Generowanie danych kwotowań do formatu CSV Autoryzacja za pomocą HTTP_AUTH Filtracja po adresach IP Strona 6

9 Strona 7