Dokumentacja sklepu

Atom API

Atom API to narzędzie pozwalające komunikować się ze sklepem AtomStore za pośrednictwem protokołu SOAP. Przy użyciu ustalonych i na bieżąco rozwijanych metod można wykonywać operacje odczytu i zapisu wybranych danych bez potrzeby logowania się do panelu administracyjnego.

 

Narzędzie jest przeznaczone dla programistów, zostało stworzone z myślą o budowie integracji z systemami magazynowo-księgowymi, ze sklepami partnerskimi etc.

 

Prezentujemy dokumentację w wersji BETA, będzie ona sukcesywnie uzupełniana. W przypadku pytań o nieopisane metody prosimy naszych klientów o zgłoszenie w BOK w panelu administracyjnym, a inne zainteresowane osoby o bezpośredni kontakt.

Adres i autoryzacja

Adres WSDL:

{domena sklepu wraz z "http://"}/atom_api/wsdl/atom_api

 

W niektórych klientach SOAP zamiast adresu WSDL wskazuje się bezpośrednio adres interfejsu (endpoint). Dla Atom API jest to:
{domena sklepu wraz z "http://"}/atom_api/call/atom_api

 

Do poprawnej autoryzacji potrzebne są login i hasło administratora przekazywane w obiekcie/tablicy do pierwszego parametru każdej z metod. Parametr ten powinien zawierać pola 'login' i 'password'. Dane te można uzyskać w panelu administracyjnym AtomStore → USTAWIENIA → ADMINISTRATORZY, ewentualnie skorzytać z tego samego loginu i hasła, które służą do logowania do panelu.

 

Dane dostępowe do demo.atomstore.pl:
WSDL: http://demo.atomstore.pl/atom_api/wsdl/atom_api
Endpoint: http://demo.atomstore.pl/atom_api/call/atom_api

Login: admin

Hasło: admin


Przykładowe wywołanie (PHP)

$client = new SoapClient('http://demo.atomstore.pl/atom_api/wsdl/atom_api');
$authenticate = array('login' => 'admin', 'password' => 'admin');
$response = $client->CheckConnection($authenticate);
echo $response;

Powyższa metoda zwraca ciąg znaków "OK" lub "WRONG AUTHORIZATION" w przypadku niepoprawnego loginu lub hasła.


Format danych

Wiodącym formatem danych w Atom API jest format XML:

 

- zwracany jako ciąg znaków (string) z metod do odczytu (np. GetProducts, GetUsers),

- przyjmowany jako ciąg znaków w parametrach funkcji do zapisu (np. SetProducts, SetUsers)

 

Niektóre proste metody do odczytu zwracają jednak zasadnicze dane bezpośrednio, nie w strukturze XML (np. GetOrderStatus - metoda zwracająca bieżący status wskazanego zamówienia). W ten sam sposób (bez struktury XML) zwracane są komunikaty błędów (np. o braku autoryzacji).


Identyfikacja produktów

Odpowiednia identyfikacja pozwala rozpoznać istniejący już w bazie Atoma produkt i zapobiega utworzeniu go po raz kolejny. Atom API dopuszcza dwa tryby identyfikowania produktów w metodach zapisu danych towarowych.

 

1. Kod produktu:

- zalecany tryb identyfikacji,

- znacznik <code> w przesyłanych do Atom API danych towarowych,

- odpowiada polu "Kod produktu" / "Kod" widniejącym w panelu administracyjnym,

- pozwala także identyfikować warianty produktów (np. różne rozmiary w ramach 1 kartoteki).

 

2. Identyfikator zewnętrzny:

- zalecany tylko wtedy, gdy nie może zostać użyta identyfikacja po kodach (np. inna integracja posługuje się kodami produktów),

- znacznik <external_id>, w niektórych metodach <product_external_id> / <externalId>,

- w panelu AtomStore pojawia się tylko w widoku USTAWIENIA → MAPOWANIE OBIEKTÓW,

- NIE pozwala identyfikować wariantów.

 

Opisane dwa sposoby identyfikacji nie powinny być mieszane ani swobodnie zmieniane. Jeśli do Atom API wysłane zostaną jednocześnie oba opisane wyżej identyfikatory, do identyfikacji wykorzystany będzie tylko identyfikator zewnętrzny (<external_id>).

 

W obu przypadkach zaimplementowane jest zabezpieczenie przed przypadkową kolejnością przesyłania danych. Jeśli na przykład w pierwszej kolejności do Atom API trafia zdjęcie produktu (SetProductsImages), tworzony jest tzw. szkielet kartoteki, która staje się widoczna po uzupełnieniu danych wywołaniem metody SetProducts. Dzięki takiemu rozwiązaniu dane nowego produktu wysłane jeszcze przed wywołaniem SetProducts nie są tracone.


AtomStore to platforma e-commerce klasy premium. Tworzymy dedykowane sklepy internetowe oraz systemy B2B. Oferujemy kompleksowe wdrożenia od A do Z, sklepy mobilne w technologii responsive web design, integracje z programami Comarch Optima, XL, WF-Mag, Subiekt. Wspólnie rozwiązujemy problemy polskiego e-handlu!

Skontaktuj się z nami

  • 12 4420443
  • kontakt@atomstore.pl