API System Partnerski

Transkrypt

1 API System Partnerski API zostało zrealizowane według wzorca REST. Komunikacja odbywa się poprzez wysłanie żądania HTTP pod adres wraz z odpowiednimi parametrami. Odpowiedź zwracana jest w formacie JSON. Obecnie obsługujemy jedynie metodę GET. GET Metoda ta służy do pozyskiwania informacji związanych z danym kontem SP. Parametry (o ile zasób na to pozwala) powinny być przesłane poprzez doklejenie ich do bazowego adresu URL. Liczba żądań wysłanych do API została ograniczona do jednego na 6 sekund. Autoryzacja Komunikacja z API odbywa się z wykorzystaniem protokołu SSL. Aby uzyskać dostęp do poszczególnych zasobów API użytkownik powinien wpierw wysłać żądanie na adres: /token wraz z odpowiednimi danymi uwierzytelniającymi (login i wygenerowany w panelu administracyjnym Systemu Partnerskiego klucz API). Dane uwierzytelniające powinny być przesłane w nagłówku 'Authorization'. Przykład: curl -H 'Accept: application/json;' -u janusz: W odpowiedzi użytkownik otrzyma token, dzięki któremu będzie mógł uwierzytelnić się łącząc do innych zasobów API. Token należy przesłać w nagłówku 'X-Auth-Token'. Przykład: curl -H 'Accept: application/json;' -H 'X-Auth-Token: a3e cb a5b93a7370' Token ważny jest 60 min. Po tym czasie należy ponownie wysłać żądanie o token.

2 Poniżej opisane zostały adresy URL i odpowiadające im typy zwracanych informacji wraz z możliwymi do przesłania parametrami. /partner-api/statusy Zwraca listę statusów wniosków. GET (metoda publiczna) "statusy_wnioskow": [ "kod": "KLK", "nazwa_krotka": "Kliknięty" "kod": "ZKC", "nazwa_krotka": "Zaakceptowany" "kod": "WTR", "nazwa_krotka": "Przetwarzany" "kod": "RZL", "nazwa_krotka": "Rozliczony" "kod": "PTW", "nazwa_krotka": "Wysłany"

3 /partner-api/produkty Zwraca listę produktów jakie kiedykolwiek pojawiły się na liście wniosków partnera. GET (publiczna) "produkty": [ "id": 1152, "nazwa": "Konto internetowe" "id": 304, "nazwa": "ikontoaktywator" "id": 609, "nazwa": "Karta kredytowa" "id": 423, "nazwa": "Lokaty"... "id": 798, "nazwa": "Konto osobiste Getin UP"

4 /partner-api/kategorie Zwraca listę kategorii produktów. GET (publiczna) "kategorie_produktu": [ "id": 123, "nazwa": "e-sklepy" "id": 41, "nazwa": "Dotacje unijne" "id": 55, "nazwa": "Kredyt pod aktywa" "id": 25, "nazwa": "Rachunki firmowe" "id": 8, "nazwa": "Lokaty i Obligacje" "id": 5, "nazwa": "Konta osobiste"... "id": 37, "nazwa": "Kredyty dla firm"

5 /partner-api/domeny Zwraca listę domen partnera. GET (wymaga autoryzacji) "domena": [ "hostname": "bankier.pl", "id": 1 "hostname": "pit.pl", "id": 6 "hostname": "vat.pl ", "id": 8 "hostname": "pb.pl", "id": "hostname": "loginsp.produktyfinansowe.pl", "id": "hostname": "demo.produktyfinansowe.pl", "id": 40117

6 /partner-api/wniosek/id Zwraca informacje o wniosku. Parametr Wartość Opis id string numer wniosku GET (wymaga autoryzacji) "wniosek": "data_otwarcia": " :45:00+01:00", "data_zmiany_statusu": " ", "domain_id": 3, "domena": "pawel-of.produktyfinansowe.pl", "etykieta": null, "numer_wniosku": " ", "produkt": "PKO BP - Max Pożyczka", "prowizja_partner": 0.0, "status_wniosku": "Wysłany", "status_wniosku_id": "PTW", "uri": "/partner-api/wniosek/163"

7 /partner-api/wnioski Zwraca listę wniosków partnera. GET (wymaga autoryzacji) ktu_id=126 Przyjmowane parametry: Parametr Wartość Opis status_wniosku_id domain_id product_id kategoria_produktu_id etykieta data_zmiany_statusu String (możliwość przesłania kilku wartości jednocześnie) Integer (możliwość przesłania kilku wartości jednocześnie) Integer (możliwość przesłania kilku wartości jednocześnie) Integer (możliwość przesłania kilku wartości jednocześnie) String (możliwość przesłania kilku wartości jednocześnie) String w formacie YYYY- MM-DD (np ) Status wniosku, lista statusów wniosków do pobrania za pomocą metody /partner-api/statusy ID domeny, lista domen dla partnera możliwa do pobrania za pomocą metody /partner-api/domeny ID produktu, lista produktów dla partnera możliwa do pobrania za pomocą metody /partnerapi/produkty ID kategorii produktu, lista kategorii możliwa do pobrania za pomocą metody /partner-api/kategorie Etykieta jaka została odłożona w bazie podczas składania wniosku Data zmiany statusu (jeśli nie zostanie podana to domyślnie brana jest dzisiejsza)

8 "wniosek": [ "data_otwarcia": " :46:59+01:00", "data_zmiany_statusu": " ", "domain_id": 32087, "domena": "loginsp.produktyfinansowe.pl", "etykieta": null, "numer_wniosku": " ", "produkt": "mbank - Konto m\u0142odzie\u017cowe", "prowizja_partner": 0.0, "status_wniosku": "Kliknięty", "status_wniosku_id": "KLK", "uri": "/partner-api/wniosek/1546" "data_otwarcia": " :02:56+01:00", "data_zmiany_statusu": " ", "domain_id": 32087, "domena": "loginsp.produktyfinansowe.pl", "etykieta": null, "numer_wniosku": " ", "produkt": "dbnet - Deutsche Bank PBC - Konto osobiste", "prowizja_partner": 0.0, "status_wniosku": "Kliknięty", "status_wniosku_id": "KLK", "uri": "/partner-api/wniosek/1545" "data_otwarcia": " :12:39+01:00", "data_zmiany_statusu": " ", "domain_id": 32087, "domena": "loginsp.produktyfinansowe.pl", "etykieta": null, "numer_wniosku": " ", "produkt": "Alior Sync - Karta kredytowa", "prowizja_partner": 0.0, "status_wniosku": "Kliknięty", "status_wniosku_id": "KLK", "uri": "/partner-api/wniosek/1544"