NeoClick Merchant API

Podobne dokumenty
1. Wstęp 2. Adres usługi 3. Konfiguracja 4. Metody 5. Typy danych 6. Przykład wywołania metody przy użyciu php i biblioteki nusoap 7.

Dokumentacja API Stacja z Paczką ver. 2.14

Dokumentacja API Stacja z Paczką ver. 2.09

Dokumentacja API serwisu KurierSerwis.com

Dokumentacja API serwisu epaka.pl

Dokumentacja API serwisu korporacjakurierska.pl

Dokumentacja API serwisu korporacjakurierska.pl

Dokumentacja WebApi FurgonetkaBiznes

[1.9.0] Zlecenia odbioru

Dokumentacja API serwisu korporacjakurierska.pl

Paczkomaty API XML D-ST D - Informacja publiczna DOCUMENT ID:

Dokumentacja API serwisu epaka.pl

Spis treści DOKUMENTACJA TECHNICZNA. STS API wersja 1.1

Dokumentacja API serwisu KurierSerwis.com

Specyfikacja API Paczka w Ruchu v

Dokumentacja smsapi wersja 1.4

Funkcje dodatkowe. Wersja 1.2.1

TRUCKER INSTRUKCJA WTYCZKI MAGENTO

Dokumentacja Api do aplikacji skanujfakture.pl

API transakcyjne BitMarket.pl

Przelewy24 Wirtualny Koszyk

[1.6.0] Walidacja formularzy

Implementacja mechanizmu SkyCashClick Wersja 0.1

Funkcje dodatkowe. Wersja 1.2.1

Automater.pl zdalne tworzenie i zarządzanie transakcjami dokumentacja API wersja 0.1

InPost dla WooCommerce. kompatybliny z wersjami: 2.3.x, 2.4.x, 2.5.x. Instrukcja obsługi

Podręcznik Integracji

Specyfikacja instalacji usługi SMS Premium w Przelewy24.pl

Dokumentacja modułu Woocommerce

WayBillsWebService. identyfikator kontrahenta, jeśli wartość zwracana jest mniejsza od zera to numer błędu.

Wdrożenie modułu płatności eservice. dla systemu Zen Cart

GlobKurier.pl profesjonalny operator logistyczny. Oszczędzaj i nadawaj przesyłki z GlobKurier.pl aż do 80% taniej!

Dokumentacja interfejsu HTTPD. Platforma BSMS.PL Instrukcja podłączenia po przez http

Przelewy24 Wirtualny Koszyk

wybierzkuriera.pl System API Dokumentacja techniczna v

SSL Reseller. Dokumentacja techniczna v.1.0 z dnia

Dokumentacja Skryptu Mapy ver.1.1

Integracja GlobKurier.pl BestSeller Instrukcja wdrożenia i konfiguracji

Dokumentacja panelu Klienta

Dokumentacja API. wersja dokumentu: kwietnia 2018 r.

Specyfikacja Płatności CashBill. Instrukcja podłączenia płatności elektronicznych do typowych zastosowań.

Baza numerów Wersja 1.1

Korporacja Kurierska

Dokumentacja panelu Klienta

Specyfikacja HTTP API. Wersja 1.6

Allegro Paczkomaty InPost Allegro Polecony InPost

InPost dla PrestaShop. kompatybliny z wersjami: 1.5, 1.6. Instrukcja obsługi

Integracja frameworku Wicket z serwisem Platnosci.pl.

apaczka Webservice API

Moduł integracji SOTE z DHL - wersja podstawowa

Spis treści. Strona: 1/26

Dokumentacja Techniczna 1.2. Webtoken MT. Uruchomienie subskrybcji MT poprzez serwis WWW

Dokumentacja interfejsu API

KURIER BY CTI. Instrukcja do programu

API przekazy masowe - Dokumentacja. v 1.1, czerwiec 2014 KIP S.A. ul. Św. Marcin 73/ Poznań.

TradeMatik 1.0. Dokumentacja dla końcowego użytkownika. Jak zainstalować wtyczkę TradeMatik, jak ją konfigurować i używać. Autor: Konrad Karpieszuk

Aktualizacja SMSFall v Data publikacji:

Opis modułu pl.id w programie Komornik SQL-VAT

dokumentacja API wersja 2.06 /

Dokumentacja techniczna API systemu SimPay.pl

DHL EXPRESS. 1 DHL IntraShip Przewodnik

LiveSpace API. Aktualizacja: 16 stycznia 2015 Wersja: 0.6. LiveSpace CRM tel: ,

APACZKA. (Moduł Magento) v Strona 1 z 11

Specyfikacja techniczna. mprofi Interfejs API

Instrukcja. nadawania przesyłek Allegro: Allegro Kurier InPost. Allegro Paczkomaty InPost. Allegro MiniPaczka InPost

Pierwsze kroki Statusy transakcji Zwrot płatności przelewem lub kartą Odbiór wpłat Czas realizacji płatności...

Dokumentacja API serwisu nacito.pl

KURIER BY CTI PROCES KONFIGURACJI I INSTRUKCJA

Integracja GlobKurier - KQS.store Instrukcja wdrożenia i konfiguracji

API System Partnerski

Korporacja Kurierska

Instrukcja importu przesyłek. z Menedżera Sprzedaży do aplikacji Webklient

Dokumentacja API BizIn

Instrukcja użytkownika. Aplikacja Smart Paczka DPD

POZNAJ DHL24 KROK PO KROKU

Instrukcja nadawania przesyłek przez platformę Manager Paczek:

DOKUMENTACJA TECHNICZNA SMS API MT

Dokumentacja REST API v 3.0. Kraków, 7 marca FreshMail, ul. Fabryczna 20a, Kraków tel , freshmail.

Dokumentacja systemu SODE.pl Data dokumentu: Wersja: 2.4.4

LiveSpace API. Aktualizacja: 27 lutego 2015 Wersja: 0.7. LiveSpace CRM tel: ,

Moduł Magento. JRD_Paczkomaty. wersja dokumentu: Autor: Kamil Borkowski SmartMage.pl

Geis Point SOAP WebService Interface

ezwroty WebApi Dokumentacja techniczna

Instrukcja korzystania z platformy B2B Black Point S.A.

Moduł integrujący serwis Korporacji Kurierskiej z programem WF-MAG Instrukcja użytkowania

LiveSpace API. Aktualizacja: 22 maja 2015 Wersja: 0.8. LiveSpace CRM tel: ,

Bezpieczne Zakupy. - specyfikacja techniczna implementacji uproszczonej

Zakupy online na fakturę z odroczonym terminem płatności

Krajowy Integrator Płatności Spółka Akcyjna

MODUŁ INTEGRUJĄCY ELEKTRONICZNEGO NADAWCĘ Z WF-MAG SPIS TREŚCI

Media Społecznos ciowe - Facebook

Instrukcja integracji modułu kurierskiego GlobKurier.pl dla platformy BaseLinker

PRZEWODNIK UŻYTKOWNIKA SERWISU. PRZESYŁKI KURIERSKIE ONLINE

POCZTA POLSKA. v Strona 1 z 9

KURIER XL BY CTI DLA SIÓDEMKA

Opis modułu pl.id w programie Komornik SQL-VAT

Wtyczka integrująca metodę wysyłki Korporacji Kurierskiej w WooCommerce

Wdrożenie modułu płatności eservice. dla systemu oscommerce 2.3.x

INSTRUKCJA INSTALACJI MODUŁU

Transkrypt:

NeoClick Merchant API Zawartość dokumentacji: Logowanie Zarządzanie przesyłkami Płatność za paczkę i utworzenie przesyłki Usunięcie przesyłki Pobranie przesyłki Edycja przesyłki Pobranie etykiety dla przesyłki Utworzenie przesyłki dla transakcji Pobranie dozwolonych typów przesyłki oraz wariantów wielkościowych Zarządzanie transakcjami pobranie transakcji pobranie wszystkich transakcji dla widgetu/integracji Zarządzanie integracjami/widgetami pobranie widgetu dodanie widgetu pobranie wszystkich widgetów dla użytkownika Zarządzanie Merchantem pobranie danych merchanta Widget Dane aplikacji Przykładowy koszyk Algorytm liczenia sygnatury Button NeoClick NeoClick Merchant API v. 0.2 str. 1 z 24

1. Logowanie Żeby zalogować się do NeoClick Merchant API należy przekazać dane metodą "POST" na URL: http://merchan t.d.neoclick.io/users/login z nagłówkiem: Content Type: application/json oraz z danymi przesłanymi w formacie Json "login": "nasz login", "password": "nasze hasło" login login merchanta password hasło Jeśli dane będą poprawne zostanie przesłany nam unikalny dla każdego użytkownika Neoclick Merchant Token "token": "string" który później będzie wykorzystywany do wszystkich zapytań dla danego użytkownika. Zalecamy zapisanie zmiennej token do sesji. W przypadku błędnie podanych danych zostanie zwrócony nam error: "status": 401, "error": "no_user_with_this_credentials" Od teraz w każdym kolejnym zapytaniu należy ustawić nagłówki: Content Type: application/json Authorization: token 2. Zarządzanie przesyłkami 2.1. Płatność za paczkę i utworzenie przesyłki aby zapłacić za paczkę i utworzyć przesyłkę należy przekazać dane metodą "POST" na URL http://merchant.d.neoclick.io /shipments/id/pay gdzie id to Id przesyłki znajdującej się w systemie Neoclick, należy też pamiętać o przesłaniu nagłówków wspominanych na końcu poprzedniego rozdziału. Jeśli wszystko wykonało się poprawnie zostanie zwrócona nam wiadomość z danymi przesyłki. NeoClick Merchant API v. 0.2 str. 2 z 24

2.1.1. Dane odbierane: "updated_at" : "2016 09 09T06:58:09.859Z", "shipment_receiver" : "company_name" : "Random Company Inc", "first_name" : "John", "last_name" : "Doe", "address_line1" : "MainStreet 1/24", "address_line2" : "string", "city" : "Warsaw", "post_code" : "12 123", "email" : "example@example.com", "phone" : "123456789", "country_code" : "string" "shipment_type" : "inpost_locker_standard", "shipment_data" : "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "parcel_target_point" : "KRA007", "personal_collection_point" : "string" "status" : "new", "charge_type" : "string", "external_id" : "string", "tracking_number" : "string", "variant" : "string" updated_at ostatnie zmiany shipment receiver odbiora przesyłki company_name nazwa instytucji first_name imie last_name nazwisko address_line1 ulica address_line2 numer domu/mieszkania city miasto post_code kod pocztowy email adres email(wartość wymagana) phone numer telefonu(wartość wymagana) country_code kod kraju do którego jest wysyłana przesyłka np PL shipment_type rodzaj przesyłki shipment data dane przesyłki weight,length,width,height rozmiary paczki, używane tylko w przypadku paczek niestandardowych parcel_target_point numer paczkomatu NeoClick Merchant API v. 0.2 str. 3 z 24

personal_collection_point punkt odbioru osobistego przypisanego do danej integracji external_id id w systemie logistycznym tracking_number numer do śledzenia przesyłki variant wariant wielkościowy(a,b,c) Tak jak poprzednio, w przypadku błędnie podanych danych lub innych błędów zostanie nam zwrócony error z wiadomością co poszło nie tak. "status" : 401, "error" : "Token missing or invalid" 2.2. Usunięcie przesyłki aby usunąć przesyłkę należy przekazać dane metodą "DELETE" na URL http://merchant.d.neoclick.io /shipments/id gdzie id to ID przesyłki. W przypadku usunięcia paczki zwracany jest nam status 204, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 2.3. Pobranie przesyłki aby pobrać dane przesyłki należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /shipments/id gdzie id to ID przesyłki. W przypadku poprawnego pobrania danych do paczki zwracany jest nam status 200 oraz dane, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 2.3.1. Dane odbierane: "updated_at" : "2016 09 09T06:58:09.875Z", "id" : 0, "shipment_receiver" : "company_name" : "Random Company Inc", "first_name" : "John", "last_name" : "Doe", "address_line1" : "MainStreet 1/24", "address_line2" : "string", "city" : "Warsaw", "post_code" : "12 123", "email" : "example@example.com", "phone" : "123456789", "country_code" : "string" "shipment_type" : "inpost_locker_standard", NeoClick Merchant API v. 0.2 str. 4 z 24

"shipment_data" : "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "parcel_target_point" : "KRA007", "personal_collection_point" : "string" "status" : "new", "charge_type" : "string", "external_id" : "string", "tracking_number" : "string", "variant" : "string" 2.4. Edycja przesyłki aby edytować dane przesyłki należy przekazać dane metodą "PATCH" na URL http://merchant.d.neoclick.io /shipments/id gdzie id to ID przesyłki oraz należy przesłać dane: 2.4.1. Dane wysyłane: "shipment_receiver" : "company_name" : "Random Company Inc", "first_name" : "John", "last_name" : "Doe", "address_line1" : "MainStreet 1/24", "address_line2" : "string", "city" : "Warsaw", "post_code" : "12 123", "email" : "example@example.com", "phone" : "123456789", "country_code" : "string" "shipment_type" : "inpost_locker_standard", "shipment_data" : "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "parcel_target_point" : "KRA007", "personal_collection_point" : "string" "variant" : "string", "updated_at" : NeoClick Merchant API v. 0.2 str. 5 z 24

W przypadku poprawnego pobrania danych do paczki zwracany jest nam status 200 oraz zaktualizowane dane paczki, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. W tym przypadku należy przesłać dane w formacie Json. Nie musimy wysyłać wszystkich pół, jeśli jakieś pola nie zostaną wysłane, to nie będą aktualizowane. Edycja przesyłki może odbywać się tylko w przypadku gdy ich status jest new. 2.5. Pobranie etykiety dla przesyłki aby pobrać etykietę dla przesyłki należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /shipments/id/label gdzie id to ID przesyłki. W przypadku poprawnego pobrania danych do paczki zwracany jest nam status 200 oraz plik w formacie pdf który należy przetworzyć, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 2.6. Utworzenie przesyłki dla transakcji aby utworzyć przesyłke należy przekazać dane metodą "POST" na URL http://merchant.d.neoclick.io /transactions/id/shipments gdzie id to ID przesyłki. W przypadku poprawnego pobrania utworzenia nowej przesyłki zwracany jest nam status 200 oraz dane utworzonej przesyłki, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 2.6.1. Dane wysyłane: "shipment_receiver" : "company_name" : "Random Company Inc", "first_name" : "John", "last_name" : "Doe", "address_line1" : "MainStreet 1/24", "address_line2" : "string", "city" : "Warsaw", "post_code" : "12 123", "email" : "example@example.com", "phone" : "123456789", "country_code" : "string" "shipment_type" : "inpost_locker_standard", "shipment_data" : "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "parcel_target_point" : "KRA007", NeoClick Merchant API v. 0.2 str. 6 z 24

"personal_collection_point" : "string" "variant" : "string", "updated_at" : Wymagane pola to : emails, phone, shipment_type, variant. 2.7. Pobranie dozwolonych typów przesyłki oraz wariantów wielkościowych aby pobrać dozwolone typy przesyłki oraz warianty wielkościowe należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /shipments/id/allowed_shipment_type s gdzie id to ID przesyłki. W przypadku poprawnego pobrania utworzenia nowej przesyłki zwracany jest nam status 200 oraz dane typów oraz wariantów, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 2.7.1. Dane odbierane: "personal_collection" : [ "default" "inpost_locker_standard" : [ "small" "inpost_courier_standard" : [ "below_2kg", "below_1kg" ] personal_collection domyślna wartość default inpost_locker_standard standard wielkości szafki(small,medium,large) inpost_courier_standard standard wielkości paczki dla kuriera( below_1kg, below_2kg, below_5kg, below_10kg, below_30kg, below_50kg ) NeoClick Merchant API v. 0.2 str. 7 z 24

3. Zarządzanie transakcjami 3.1. pobranie transakcji aby pobrać transakcje należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /transactions/id gdzie id to ID przesyłki. W przypadku poprawnego pobrania transakcji zwracany jest nam status 200 oraz dane transakcji, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 3.1.1. Dane odbierane: "transaction_id" : "string" "shipments" : [ "updated_at" : "2016 09 09T06:58:09.916Z", "id" : 0, "shipment_receiver" : "company_name" : "Random Company Inc", "first_name" : "John", "last_name" : "Doe", "address_line1" : "MainStreet 1/24", "address_line2" : "string", "city" : "Warsaw", "post_code" : "12 123", "email" : "example@example.com", "phone" : "123456789", "country_code" : "string" "shipment_type" : "inpost_locker_standard", "shipment_data" : "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "parcel_target_point" : "KRA007", "personal_collection_point" : "string" "status" : "new", "external_id" : "string", "tracking_number" : "string", "variant" : "string" ] transaction_id = numer transakcji status = status transakcji(new) NeoClick Merchant API v. 0.2 str. 8 z 24

shipments paczki(dane opisane w rozdziale zarządzanie paczką) 3.2. pobranie wszystkich transakcji dla widgetu/integracji aby pobrać transakcje należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /intetgrations/id/transactions gdzie id to ID widgetu/integracji. W przypadku poprawnego pobrania transakcji zwracany jest nam status 200 oraz dane transakcji, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 3.2.1. Dane odbierane [ ] "transaction_id" : "string", "status" : 0, "shipments" : [ "updated_at" : "2016 09 09T06:58:09.944Z", "id" : 0, "shipment_receiver" : "company_name" : "Random Company Inc", "first_name" : "John", "last_name" : "Doe", "address_line1" : "MainStreet 1/24", "address_line2" : "string", "city" : "Warsaw", "post_code" : "12 123", "email" : "example@example.com", "phone" : "123456789", "country_code" : "string" "shipment_type" : "inpost_locker_standard", "shipment_data" : "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "parcel_target_point" : "KRA007", "personal_collection_point" : "string" "status" : "new", "charge_type" : "string", "external_id" : "string", "tracking_number" : "string", "variant" : "string" ] NeoClick Merchant API v. 0.2 str. 9 z 24

charge_type Określa sposób w jaki konto merchanta zostało obciążone za utworzenie przesyłki (ze środków pre paid lub post paid). NeoClick Merchant API v. 0.2 str. 10 z 24

4. Zarządzanie integracjami/widgetami 4.1. pobranie widgetu aby pobrać integracje/widget należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /intetgrations/id/ gdzie id to ID widgetu/integracji. W przypadku poprawnego pobrania transakcji zwracany jest nam status 200 oraz daneintegracji, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 4.1.1. Dane odbierane "secret" : "secret", "label" : "label", "app_id" : "1", "currency" : "PLN", "allowed_payments" : [ "name" : "ECARD_CARD", "price" : 0 "config_options" : [ "key" : "dotpaytestmode", "value" : "1" "key" : "dotpaysellerpin", "value" : "4" "key" : "dotpaysellerid", "value" : "4161" "key" : "ecardtestmode", "value" : "1" "key" : "ecardmerchantnumber", "value" : "0" "key" : "ecardsecretkey", "value" : "78" NeoClick Merchant API v. 0.2 str. 11 z 24

"key" : "ecardclientidkey", "value" : "737" "key" : "signingkey", "value" : "498109" "key" : "paymentunsuccessfulurl", "value" : "http://wintheiser.com/" "key" : "paymentsuccessfulurl", "value" : "http://www.mueller.biz/rerum ut et enim ex eveniet facere sunt" "key" : "sitelogolargeurl", "value" : "http://heathcote.org/ut sunt et quidem est accusamus aut.html" "key" : "sitelogomedurl", "value" : "https://www.streich.com/odit amet et est ut" "key" : "sitelogostdurl", "value" : "http://langworth.info/aut officia aut aut.html" "key" : "sitetermsandconditionsurl", "value" : "https://www.mcclure.com/voluptas sed a nam" "key" : "siteurl", "value" : "https://mckenzie.info/incidunt saepe provident esse hic eligendi.html" "shipment_types_prices" : [ "variant" : "default", "type" : "personal_collection", "price" : 0 "variant" : "small", "type" : "inpost_locker_standard", "price" : 1750 "variant" : "below_2kg", "type" : "inpost_courier_standard", "price" : 1650 NeoClick Merchant API v. 0.2 str. 12 z 24

"variant" : "below_1kg", "type" : "inpost_courier_standard", "price" : 750 "shipment_services_prices" : [ "name" : "cod", "price" : 0 "name" : "cod", "price" : 0 "name" : "cod", "price" : 0 "name" : "cod_under_1000", "price" : 350 "name" : "cod_under_1000", "price" : 500 "dispatch_points" : [ "id" : 1, "name" : "Stanford Bins", "city" : "Port Maynardport", "country_code" : "MM", "post_code" : "12 123", "street" : "Hillary Plains", "building_number" : "8" "personal_collection_points" : [ "id" : 1, "name" : "nostrum", "street" : "Conroy Harbors", "house_number" : "2", "flat_number" : "1", "postal_code" : "12 123", "city" : "Port Derick", "phone_number" : "624029983", "opening_hours" : "doloribus" "promotions" : [], NeoClick Merchant API v. 0.2 str. 13 z 24

"href" : "http://192.168.108.223:7000/v1/integrations/1" secret label nazwa widgetu app_id id w systemie logistycznym currency waluta allowed_payments dozwolone płatności name nazwa płatności price? config_options opcje konfiguracyjne key nazwa opcja value wartość shipment_type_prices rodzaje płatności za przesyłki variant wariant przesyłki type typ przesyłki price cena shipment_services_prices? name nazwa value cena dispatch_ points miejsca wysyłki id numer name nazwa city miasto country_code kod państwa post_code kod pocztowy street ulica building_number numer budynku personal_collection_points punkt odbioru osobistego id numer name nazwa street ulica house_number numer domu flat_number numer bloku postal_code kod pocztowy city 0 miasto phone_number numer telefonu opening_hours godziny otwarcia 4.2. dodanie widgetu aby utworzyć nową integracje/widget należy przekazać dane metodą "POST" na URL http://merchant.d.neoclick.io /intetgrations/id/ gdzie id to ID widgetu/integracji. W przypadku poprawnego pobrania transakcji zwracany jest nam status 200 oraz daneintegracji, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. NeoClick Merchant API v. 0.2 str. 14 z 24

4.2.1. Dane wysyłane: [ "secret" : "string", "label" : "string", "app_id" : "string", "currency" : "string", "allowed_payments" : [ "name" : "string", "price" : 0 "config_options" : [ "key" : "string", "value" : "string" "shipment_types_prices" : [ "variant" : "string", "type" : "string", "price" : "string" "shipment_services_prices" : [ "type" : "string", "name" : "string", "price" : 0 "dispatch_points" : [ "phone" : "string", "email" : "string", "name" : "string", "office_hours" : "string", "comments" : "string", "extra_data" : "string" "personal_collection_points" : [ "name" : "string", "street" : "string", "house_number" : "string", "flat_number" : "string", "postal_code" : "string", NeoClick Merchant API v. 0.2 str. 15 z 24

] "city" : "string", "phone_number" : "string", "opening_hours" : "string" "promotions" : [ "external_id" : "string", "name" : "string", "payment_type" : "string", "shipment_type" : "string", "shipment_services_exclusion" : "string", "shipment_discount_price" : 0, "shipment_discount_percentage" : 0 ] 4.2.2. Dane odbierane: "secret" : "string", "label" : "string", "app_id" : "string", "currency" : "string", "allowed_payments" : [ "name" : "string", "price" : 0 ], "config_options" : [ "key" : "string", "value" : "string" "shipment_types_prices" : [ "variant" : "string", "type" : "string", "price" : "string" "shipment_services_prices" : [ "type" : "string", "name" : "string", "price" : 0 NeoClick Merchant API v. 0.2 str. 16 z 24

"dispatch_points" : [ "phone" : "string", "email" : "string", "name" : "string", "office_hours" : "string", "comments" : "string", "extra_data": "string" ], "personal_collection_points": [ "name": "string", "street": "string", "house_number": "string", "flat_number": "string", "postal_code": "string", "city": "string", "phone_number": "string", "opening_hours": "string" ], "promotions": [ "external_id": "string", "name": "string", "payment_type": "string", "shipment_type": "string", "shipment_services_exclusion": "string", "shipment_discount_price": 0, "shipment_discount_percentage": 0 ] 4.3. pobranie wszystkich widgetów dla użytkownika aby pobrać integracje/widgety należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /merchants/id/integration s gdzie id to ID merchanta. W przypadku poprawnego pobrania transakcji zwracany jest nam status 200 oraz dane integracji, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. NeoClick Merchant API v. 0.2 str. 17 z 24

4.3.1. Dane odbierane: [ "secret" : "string", "label" : "string", "app_id" : "string", "currency" : "string", "allowed_payments" : [ "name" : "string", "price" : 0 "config_options" : [ "key" : "string", "value" : "string" "shipment_types_prices" : [ "variant" : "string", "type" : "string", "price" : "string" "shipment_services_prices" : [ "type" : "string", "name" : "string", "price" : 0 "dispatch_points" : [ "phone" : "string", "email" : "string", "name" : "string", "office_hours" : "string", "comments" : "string", "extra_data" : "string" "personal_collection_points" : [ "name" : "string", "street" : "string", "house_number" : "string", NeoClick Merchant API v. 0.2 str. 18 z 24

] "flat_number" : "string", "postal_code" : "string", "city" : "string", "phone_number" : "string", "opening_hours" : "string" "promotions" : [ "external_id" : "string", "name" : "string", "payment_type" : "string", "shipment_type" : "string", "shipment_services_exclusion" : "string", "shipment_discount_price" : 0, "shipment_discount_percentage" : 0 ] NeoClick Merchant API v. 0.2 str. 19 z 24

5. Zarządzanie Merchantem 5.1. pobranie danych merchanta aby pobrać dane merchanta należy przekazać dane metodą "GET" na URL http://merchant.d.neoclick.io /users/merchant/. W przypadku poprawnego pobrania transakcji zwracany jest nam status 200 oraz dane integracji, a w przypadku błędu tak jak w poprzednich przypadkach error z wiadomością. 5.1.1. Dane odbierane: "id" : 0, "name" : "John Doe", "address_line1" : "Some street", "address_line2" : "1/24B", "city" : "Warsaw", "post_code" : "12 123", "email" : "string", "phone" : "string", "tax_id" : "1234563218", "account_balance" : 100.9, "debit_limit" : 10.6, "country_code" : "PL", "shipment_types" : [ "id" : 0, "name" : "inpost_courier_standard" ] id numer użytkownika name imie i nazwisko address_line1 ulica address_line2 numer domu city miasto post_code kod pocztowy email adres email phone numer telefonu tax_id numer rachunku account_ballance bilans konta debit limit limit devetowy country_code kod kraju shipment_types typy przesyłek id numer typu name nazwa NeoClick Merchant API v. 0.2 str. 20 z 24

6. Widget 6.1. Dane aplikacji: appid: 1470328260390915 signingkey: a3174b4983946e5357738b937ee4c890 6.2. Przykładowy koszyk: "appid": "1470328260390915", "currency": "PLN", "type": "real", "correlationid": "AAAA 123456789", "articles": [ "id": "producta", "name": "T shirt", "price": 2500, "quantity": 1, "dimensions": "width": 50, "height": 30, "depth": 5, "weight": 300, "id": "productb", "name": "Kubek biały", "price": 300, "quantity": 5, "dimensions": "width": 20, "height": 20, "depth": 30, "weight": 500 ], "dimensions": "width": 300, "height": 400, "depth": 500, "weight": 600, "signature": "" NeoClick Merchant API v. 0.2 str. 21 z 24

6.3. Algorytm liczenia sygnatury: 1. oznaczenie appid wartość pola appid 2. oznaczenie [articles[x].namearticles[x].id] sekwencja liczona dla każdego artykułu z listy articles 3. jeżeli wartość dla danego pola nie istnieje, uznajemy że jej wartość to pusty napis Ciąg wejściowy zbudowany jest z: input = appid[articles[x].dimensions.deptharticles[x].dimensions.height articles[x].dimensions.weigtharticles[x].dimensions.widtharticles[x].id articles[x].namearticles[x].quantityarticles[x].price]correlationidc urrencydimensions.depthdimensions.heightdimensions.weigthdimensions.w idthtype Wartość sygnatury: signature = sha256( input + signingkey ) Przykład dla powyższego koszyka: input = 1470328260390915 + 5 + 30 + 300 + 50 + producta + T shirt + 1 + 2500 + 30 + 20 + 500 + 20 + productb + Kubek biały + 5 + 300 + AAAA 123456789 + PLN + 500 + 400 + 600 + 300 + real zatem: input = 147032826039091553030050productAT shirt12500302050020productbkubek biały5300aaaa 123456789PLN500400600300real signature = sha256 ( 147032826039091553030050productAT shirt12500302050020productbkubek biały5 300AAAA 123456789PLN500400600300real + a3174b4983946e5357738b937ee4c890) signature: 49820c421bd57993e5b96043729e88c0e7bbd52ac3aa6bba655ab66ee7f1da85 6.4. Button NeoClick: <div class="neo click button" data layout="standard" data position="right"></div> 6.4.1. KOD JavaScript: window.neoclickasyncinit = function() NeoClick.init( appid: "1470328260390915", redirecturi: 'http://neoclick.io' ); NeoClick.setBasket( NeoClick Merchant API v. 0.2 str. 22 z 24

; "currency": "PLN", "type": "real", "correlationid": "AAAA 123456789", "articles": [ "id": "producta", "name": "T shirt", "price": 2500, "quantity": 1, "dimensions": "width": 50, "height": 30, "depth": 5, "weight": 300, "id": "productb", "name": "Kubek biały", "price": 300, "quantity": 5, "dimensions": "width": 20, "height": 20, "depth": 30, "weight": 500 ], "dimensions": "width": 300, "height": 400, "depth": 500, "weight": 600, "signature": "" ); (function(d) var js, id = 'neoclick jssdk', ref = d.getelementsbytagname('script')[0]; if (d.getelementbyid(id)) return; js = d.createelement('script'); js.id = id; js.async = true; js.src = "http://panel.d.neoclick.io/sdk/neo click.js"; ref.parentnode.insertbefore(js, ref); (document)); 6.4.2. Opis wymaganych metod i parametrów w JavaScript SDK. Skrypt linkujący bibliotekę JavaScript SDK służącą do wywołania widgetu, oraz przycisku kupuję z NeoClick należy umieścić przed znacznikiem <body>! (function(d) NeoClick Merchant API v. 0.2 str. 23 z 24

var js, id = 'neoclick jssdk', ref = d.getelementsbytagname('script')[0]; if (d.getelementbyid(id)) return; js = d.createelement('script'); js.id = id; js.async = true; js.src = "http://panel.d.neoclick.io/sdk/neo click.js"; ref.parentnode.insertbefore(js, ref); (document)); Metoda inicjująca widget NeoClick.init() parametry: appid identyfikator aplikacji redirecturi url ustawiany przez merchanta Metoda do konfiguracji koszyka NeoClick.setBasket() parametry: currency waluta type real (produkty fizyczne), virtual (produkt wirtualny) correlationid identyfikator nadawany przez merchanta dla koszyka w celu późniejszej identyfikacji zamówień, nie jest wymagany articles tablica produktow dimensions rozmiary paczki dla wszystkich produktow (opcjonalne) signature wartość sygnatury (algorytm liczenia powyżej) W tablicy articles również występuje pole dimensions. Istnieją 2 sposoby ustawiania parametru dimensions: 1. Dla kazdego produktu osobno (wtedy główny parametr dimensions nie jest ustawiany). 2. Dla całego zamówienia (wtedy w tablicy articles nie ustawiamy dimensions dla zadnego produktu). NeoClick Merchant API v. 0.2 str. 24 z 24