API Panelu administracyjnego IAI-Shop.com

API Panelu IAI-Shop.com pozwala na wykonywanie operacji przez aplikacje zewnętrzne, w taki sam sposób jak wykonuje operacje "ręcznie" w panelu administracyjnym IAI-Shop.com użytkownik. Dzięki API Panelu administracyjnego możliwe jest łączenie aplikacji gotowych i pisanych indywidualnie i automatyzacja wymiany informacji. Każdy system IAI-Shop.com posiada własne API, zawsze włączone.

Wydajność API

API wykorzystuje moc obliczeniową Twojego serwera

Icon Pamiętaj, że korzystanie z API wiąże się z wykorzystaniem mocy obliczeniowej Twojego serwera. Dlatego zanim zaczniesz używać naszego API - upewnij się, że posiadasz wystarczający zapas mocy obliczeniowej, aby obsłużyć dodatkowe, spore nakłady obliczeniowe związane z aktualizacjami informacji, często intensywnymi, w jednym czasie. Nie uwzględnienie tego, odbije się na dostępności sklepu. Możesz rozważyć też ustawienie aktualizacji w okresie mniejszego obciążenia.

  • W przypadku abonamentu CLOUD zapas mocy zapewniany jest przez IAI. Pewna pula wywołań API jest w cenie abonamentu. Jeśli ją przekroczysz, będziemy naliczali za kolejne dopłaty, zgodnie z Cennikiem IAI-Shop.com.
  • W przypadku abonamentu DEDICATED i planu indywidualnego nie ma opłat związanych z ilością wywołań API. Ale intensywne korzystanie z niego może wymagać dokupenia zapasu mocy poprzez wykupienie wyższego planu abonamentowego.

Optymalizuj wywołania API

Częstym błędem jest skupianie się na jak najprostszym (i często najtańszym) napisaniu aplikacji integrującej, która np. w pętli, wysyła aktualizowanie wszystkich informacji. Taki program będzie prowadził do niepotrzebnego przeciążania API. Powinieneś starać się wysyłać do API jedynie to co faktycznie ma sens. Inaczej Twój serwer będzie przeciążony lub wyższe faktury za wynajem systemu szybko zwielokrotnią oszczędność na stworzeniu dobrego programu.

Optymalizuj ilość requestów. Niektore bramki pozwalają na aktualizowanie wielu encji jednocześnie. Warto wykorzystywać tę funkcjonalność, gdyż przyśpiesza ona mocno aktualizację. Również nie loguj się przed każdym requestem, korzystając z utrzymywania otwartego połączenia.

Funkcjonalności w API

API działa tak samo jak opcje w panelu administracyjnym Twojego sklepu

Od początku przyjęliśmy założenie, że API Panelu Administracyjnego (API PA) jest zgodne z opcjami dostępnymi w panelu i pozwala na wykonywanie operacji na takiej samej zasadzie, na jakiej ich wykonywanie działa w panelu. Oznacza to, że API PA, posiada choćby takie ograniczenia jak np. brak możliwości wgrywania stanów magazynowych do towarów na inne magazyny niż M0, jeśli jest wybrana gospodarka magazynowa IAI-Shop.com.

Jeśli więc planujesz wdrożyć jakąś funkcjonalność w oparciu o nasze API, to sprawdź najpierw jak dana opcja zachowuje się w panelu, ponieważ nasze API będzie zachowywać się identycznie. Odradzamy developowanie programu, bez wcześniejszego poznania i skonfigurowania najpierw panelu administracyjnego.

Logowanie i raportowanie błędów

Tworząc własny program integrujący się z IAI-Shop.com, zadbaj o to, aby Twój klient miał możliwość wysłania nam informacji diagnostycznych np. żądania i odpowiedzi API oraz logi. Nasze API zwraca różnego rodzaju komunikaty błędu. Obsłuż je prawidłowo w swoim programie, tak aby nasz wspólny klient wiedział skąd wziął się problem, po której stronie powstał i mógł przynajmniej podjąć próby jego samodzielnego rozwiązania.

API jest wciąż rozwijane

W momencie pojawienia się nowej opcji w panelu administracyjnym IAI-Shop.com nie zawsze od razu dana funkcjonalność jest oprogramowana w API. Nie oznacza, to jednak że nasze API nie zostanie wkrótce potem uzupełnione. Stale wsłuchujemy się w potrzeby developerów, więc jeżeli czegoś Ci brakuje, prosimy o kontakt.

API jest wersjonowane

Sami jesteśmy developerami i bardzo denerwuje nas, gdy API naszego partnera zmienia się, bez dania nam czasu na reakcję. Dlatego sporo pracy włożyliśmy w tzw. wersjonowanie API. Ilekroć zmieniamy coś w API, zmiany są widoczne w postaci tzw. nowej wersji. Tworząc nowy program, zawsze korzystaj z najnowszej wersji API.

Aktualizuj program nie rzadziej niż raz na 24 miesiące

Od momentu opublikowania nowej wersji API PA gwarantujemy, że o ile to możliwe, utrzymamy 24 miesięczne, niezmienione działanie. Oznacza to, że korzystając z najnowszej wersji naszego API od momentu jej opublikowania masz gwarancję, że przez 24 miesiące nie wyłączymy jej funkcjonowania. To z kolei oznacza, że raz stworzony program / usługa działająca w oparciu o API PA będzie musiała być przez Ciebie serwisowana przynajmniej raz na 2 lata. Masz więc dużo czasu, aby dostosować swoją aplikację do nowszych wersji API PA, ale nie zakładaj że API nigdy się nie zmieni. Zaplanuj raz na 2 lata aktualizację obsługi API, podczas której powinieneś przejrzeć także zmiany w działaniu całego systemu.

Zaktualizuj zintegrowaną wersję zanim coś zgłosisz

Zanim coś zgłosisz, upewnij się, że korzystasz z najnowszej wersji API. W nowej wersji to co chcesz zgłosić mogło zostać poprawione lub dodane.

Bezpieczeństwo: Uważaj komu dajesz dostęp do API

Uważaj z kim współpracujesz i komu dajesz dostęp do API PA. Za pomocą dostępnych w naszym API metod możliwe jest np. zaksięgowanie wpłaty mimo iż pieniądze nie dotarły. Warto zdawać sobie sprawę z zagrożeń jakie za tym idą (np. możliwość kradzieży towaru). To czy dany użytkownik panelu posiada dostęp do API i których modułów, możesz ustalić na karcie użytkownika w module ADMINISTRACJA / Zarządzanie użytkownikami panelu, tak samo jak robisz to dla dostępu z poziomu panelu administracyjnego. Kieruj się przy tym zasadą dawania minimalnego dostępu, stopniowo go powiększając, zamiast dawania wszystkich uprawnień od razu.

API Panelu administracyjnego to nie jedyne API jakie mamy

API PA to nie jedyne API jakie oferujemy. Często początkujący developerzy próbują błędnie zrobić wszystko przy jego pomocy, podczas gdy stworzyliśmy szereg różnych sposobów wymiany informacji, dedykowanych konkretnym zastosowaniom i poziom uprawnień.