15 listopada 2010

Znaczna rozbudowa API IAI-Shop.com

W ostatnim czasie, w API IAI-Shop.com zachodzą bardzo istotne zmiany. Warto przy tej okazji przypomnieć, że IAI-Shop.com wprowadziło API, otwarte, darmowe, w standardzie SOAP już w 2007r. Było to pionierskie posunięcie, gdyż w tym czasie raczej królowało przerabianie otwartego kodu. IAI postawiło na inaczej zdefiniowaną otwartość, która przetrwała próbę czasu i 4 lata później, API jest niemal w pełni kompatybilne z bramkami sprzed 4 lat i stale je rozbudowujemy. W ostatnim czasie zostało udostępnionych wiele bramek o które prosili nas developerzy piszący samodzielnie programy rozszerzające możliwości IAI-Shop.com. Programy takie nie jest napisać wcale trudno. Dzięki API można zbudować np. własne reguły przetwarzania zamówień lub generowania danych np. do personalizowanej wysyłki newsletterów czy podejmowania innych akcji.

Zmiany w dokumentacji

  • Pic. 1 - Widok na nową podstronę www.iai-shop.com/api.phtml zawierającą dokumentację wraz z przykładami zastosowań API i linkami do plików WSDL

Dokumentacja do API była do tej pory dostępna w panelu sklepu. Utrudniało to budowanie aplikacji przez developerów z firm trzecich. Dlatego od dzisiaj, dokumentacja przeniesiona została wzorem Pomocy, z panelu na stronę www.IAI-Shop.com. Jej adres to https://www.idosell.com/pl/shop/api.phtml . Można do niej dotrzeć również przez dotychczasowe linki. Dzięki tej zmianie, zlecając zmiany do swoich programów firmom zewnętrznym, mogą Państwo nie udostępniać swoich sklepów, wystarczy skierowanie programistów do tej dokumentacji bezpośrednio na stronie. Dokumentacja do API docelowo zostanie również przepisana w całości i przetłumaczona na język angielski.

Najistotniejsze zmiany do API

API OrdersDocuments - to nowe API umożliwiające pobieranie informacji o wystawionych dokumentach sprzedaży do zamówień. Metoda "getDocuments" zwraca listę dokumentów, które zostały wystawione dla danego zamówienia. Dokumenty zwracane są w formacie PDF i zakodowane w standardzie Base64. API zwraca następujące typy dokumentów sprzedaży:

  • Potwierdzenie sprzedaży (sales_confirmation)
  • Faktura VAT (vat_invoice)
  • Faktura VAT korygująca (corrective_vat_invoice)
  • Faktura VAT zaliczkowa (advance_vat_invoice)
  • Faktura VAT końcowa (final_advance_vat_invoice)
  • Faktura pro forma (pro_forma_invoice)
  • Faktura pro forma zaliczkowa (advance_pro_forma_invoice)
  • Faktura pro forma końcowa (final_advance_pro_forma_invoice)
  • Wydanie zewnętrzne (delivery_note)

API Payments - nowe API umożliwiające kompleksowe zarządzanie wpłatami do zamówień. Pozwala na dokonywanie z poziomu API takich operacji jak: dodawanie wpłat, księgowanie wpłat, anulowanie wpłat, edycja. API Payments wyposażone jest w następujące metody:

  • getPayment - metoda zwraca podstawowe informacje o danej wpłacie
  • addPayment - metoda umożliwia dodanie nowej wpłaty
  • confirmPayment - metoda służy do zatwierdzania wpłaty
  • cancelPayment - umożliwia anulowanie wpłaty
  • setPayment - pozwala na edycje informacji o wpłacie
  • getPaymentForms - metoda zwraca listę dostępnych form płatności

API Dictionaries - API przeznaczone do zarządzania słownikami opisów towarów. Obecnie API wyposażone jest w metody zwracające informacje o słownikach, grupach i elementach słowników. W przyszłości zostanie rozbudowane o metody pozwalające na definiowanie i zarządzanie słownikami, grupami i elementami słowników.API Dictionaries udostępnia następujące metody:

  • getDictionaries - zwraca listę zdefiniowanych słowników
  • getDictionariesGroup - zwraca grupy elementów słowanika
  • getDictionariesElements - zwraca listę elementów słownika

Dodatkowo w API setProducts wprowadzone zostały zmiany pozwalające na przypisywanie słowników do towarów. Dzięki tym zmianom można już implementować własne rozwiązanie automatyzujące przypisywanie i aktualizację słownikowych opisów towarów.

API getUsers - metoda zwracająca listę użytkowników panelu oraz podstawowe informacje o użytkownikach, takie jak: login, imię i nazwisko, uprawnienia do poszczególnych modułów.

W najbliższej przyszłości planujemy wprowadzenie nowego API Clients do zarządzania klientami sklepu.