IdoSell — konfiguracja, integracje i funkcje

IdoSell API umożliwia wymianę danych między sklepem a zewnętrznymi systemami.
Przez API Panelu Administracyjnego IdoSell można generować etykiety paczek Smile i pobierać je do innych systemów.¹ Dalej znajdziesz informacje o dostępie, dostępnych operacjach i warunkach przygotowania integracji.

Czym jest API IdoSell i do czego służy?

Program wysyła do API żądanie dotyczące wybranego zasobu, po czym odczytuje odpowiedź. To, co może zrobić, zależy od metody API oraz uprawnień użytych przy połączeniu².

Etykieta dla paczki jest dokumentem potrzebnym do obsługi przesyłki. Metody API opisane przy etykietach Smile mają szersze zastosowanie: obsługują także inne etykiety.¹ W integracji warto więc rozdzielić wybór metody od rodzaju etykiety.

Dokumentacja IdoSell API podaje parametry żądania, format odpowiedzi i uprawnienia wymagane przy danej operacji. Deweloperzy mogą też wysłać pytania o IdoSell API na adres developers@idosell.com.¹

Poniższa lista pokazuje kolejność prac przy obsłudze etykiet Smile przez API Panelu Administracyjnego IdoSell.

• Wybór metody API określa, jaką operację wykonasz na etykiecie. Do tej metody dopasuj parametry żądania.
• Przygotowanie żądania wymaga uwierzytelnienia, podania wymaganych parametrów oraz danych właściwej przesyłki.
• Obsługa odpowiedzi polega na odczytaniu wyniku i zapisaniu informacji potrzebnych do dalszej pracy z etykietą.

Jakie operacje na produktach, zamówieniach i klientach umożliwia API IdoSell?

Operacje na produktach, zamówieniach i klientach wymagają dobrania metod API do właściwych danych. Zasób oznacza grupę danych, której dotyczy żądanie, na przykład produkt lub zamówienie. Przy każdym zasobie ustal osobno, czy metoda odczytuje dane, czy je zmienia. Dla zasobu orders/orders IdoSell podaje trzy typy operacji: GET, POST i PUT³.

Integracja zamówień wymaga uwzględnienia pól obowiązkowych dla metody i sposobu wskazania konkretnego zamówienia. Gdy przesyłasz dane klientów, ogranicz ich zakres do tego, czego wymaga cel integracji⁴.

Jak uzyskać dostęp do API IdoSell i ustawić uprawnienia?

Dostęp do API IdoSell przygotuj pod system, który będzie z niego korzystać, oraz operacje, które ma wykonywać. O tym, do jakich zasobów sięgnie ten system, decydują przyznane mu uprawnienia.

• Zakres integracji obejmuje zasoby i operacje potrzebne zewnętrznemu systemowi. Rozdziel uprawnienia do odczytu od uprawnień do zmiany danych².
• Dane dostępowe uwierzytelniają żądania. Przechowuj je w systemie integrującym, nie w kodzie widocznym dla osób odwiedzających sklep.
• Uprawnienia połączenia dopasuj do zadań integracji. System nie potrzebuje dostępu do zasobów, których nie obsługuje.

Połączenie z API można wypróbować, gdy metoda, dane dostępowe i uprawnienia odnoszą się do tej samej operacji.
Błąd uwierzytelnienia API IdoSell sygnalizuje kodem HTTP 401⁵.

Jak wysłać żądanie do API IdoSell i odczytać odpowiedź?

Żądanie do API IdoSell buduj według opisu wybranej metody, a odpowiedź odczytuj w przewidzianym dla niej formacie. HTTP jest protokołem, za pomocą którego systemy przesyłają żądania i odpowiedzi. Dla bramki dotyczącej podmiotów odpowiedzialnych dokumentacja IdoSell wymienia cztery metody HTTP: GET, POST, PUT i DELETE⁶.

• Wybór operacji wskazuje metodę API i zasób objęty żądaniem. Przygotuj dane wejściowe zgodnie z opisem metody.
• Wysłanie żądania wymaga danych uwierzytelniających i parametrów operacji. Nie zapisuj danych dostępowych w publicznym skrypcie.
• Odczyt odpowiedzi pozwala sprawdzić wynik, zwrócone dane lub komunikat błędu. Zanim przetworzysz wynik, ustal, czy operacja się powiodła.

Poprawna obsługa odpowiedzi pozwala odróżnić dane zwrócone przez API od informacji o nieudanej operacji⁴.

Jakie są częste przyczyny błędów przy korzystaniu z API IdoSell?

Błędy API IdoSell mogą dotyczyć uwierzytelnienia, uprawnień albo parametrów żądania. Nieprawidłowe dane dostępowe uniemożliwiają rozpoznanie systemu, który wysłał żądanie. Zbyt wąskie uprawnienia blokują operację na zasobie, choć samo połączenie może działać. Błędna nazwa, wartość lub format parametru sprawiają z kolei, że żądanie nie spełnia wymagań metody.
Odmowę dostępu do operacji dokumentacja API IdoSell oznacza kodem HTTP 403⁵.

Diagnozę błędu zacznij od odpowiedzi API. Następnie sprawdź dane dostępowe, uprawnienia oraz parametry tego konkretnego żądania. Nieprawidłowy format danych żądania ma w dokumentacji API IdoSell kod HTTP 422⁵.

Jak połączyć API IdoSell z innymi systemami?

Połączenie IdoSell z zewnętrznym systemem wymaga powiązania operacji sklepu z żądaniem API i jego odpowiedzią. Najpierw ustal, jakie dane mają przepływać między systemami i w którą stronę. Potem wybierz metodę API, przygotuj uwierzytelnienie i przetestuj wynik na danych odpowiadających planowanemu procesowi.

WMS zarządza pracą magazynu, a ERP wspiera zarządzanie zasobami przedsiębiorstwa. Przy integracji wskaż, który system odpowiada za poszczególne etapy obsługi zamówienia. Zaplanuj też reakcję na nieudane żądanie, żeby błąd połączenia nie oznaczał w systemie zakończonej operacji.
Kod HTTP 500 wskazuje wewnętrzny błąd serwera; takiego żądania nie należy uznawać za wykonane⁵.

Jakie zadania może obsługiwać integracja z IdoSell?

Integracja z IdoSell może dostarczać zewnętrznemu systemowi dane potrzebne do wybranego procesu. Generowanie i pobieranie etykiet Smile przez API przydaje się przy obsłudze zamówień we własnym WMS. Z tych operacji może też korzystać firma fulfillmentowa, która magazynuje i wysyła towary w imieniu sklepu.¹ W obu wariantach etykieta musi trafić do właściwego zamówienia w systemie obsługującym wysyłkę.

Jak sprawdzić, czy połączenie z API IdoSell działa poprawnie?

Połączenie z API IdoSell przetestujesz, wysyłając żądanie dla wybranej operacji. Następnie porównaj odpowiedź z oczekiwanym wynikiem. Dla poprawnego odczytu danych zamówienia dokumentacja przewiduje kod HTTP 200⁷.

• Żądanie testowe powinno dotyczyć operacji wykonywanej później przez integrację. Wyślij je z danymi dostępowymi przeznaczonymi dla tego połączenia.
• Odpowiedź API zawiera wynik żądania. Jeśli operacja się nie powiodła, odczytaj komunikat błędu.
• Wynik w systemie zewnętrznym powinien odpowiadać danym z API. Sprawdź, czy został przypisany do właściwego zamówienia.

Test połączenia kończy się powodzeniem, gdy odpowiedź API i zapis w zewnętrznym systemie dotyczą tej samej operacji.

Jak przebiega wymiana danych między IdoSell a zewnętrznym systemem?

Wymiana danych między IdoSell a zewnętrznym systemem zaczyna się od żądania. System, który je wysłał, odbiera odpowiedź i przetwarza wynik. Kody HTTP od 200 do 299 należą do klasy odpowiedzi oznaczających pomyślne przetworzenie żądania⁸.

• System inicjujący wybiera operację i przygotowuje dane wymagane przez odpowiednią metodę API.
• API IdoSell przyjmuje żądanie i odsyła odpowiedź dotyczącą wykonanej operacji.
• System odbierający odczytuje odpowiedź i przypisuje wynik do właściwego rekordu, na przykład zamówienia.

Integracja działa prawidłowo, gdy oba systemy wiążą wynik operacji z tym samym zamówieniem.

Moduły sklepu a API IdoSell: zakres i warunki integracji

IdoSell pozwala połączyć moduł sklepu internetowego z innym systemem przez interfejs dobrany do zadania. Moduł jest częścią oprogramowania, która wykonuje określoną pracę w sklepie. Przy wyborze interfejsu ustal, czy łączysz moduł, czy skrypt działający w interfejsie sklepu.

Tabela zestawia interfejs SOAP z prostszym API IdoSell według zastosowań opisanych przez dostawcę.

Dane w tabeli: 9

Zakres integracji zależy od zadania modułu lub skryptu. Moduł sklepu wymaga zaplanowania wymiany danych z zapleczem. JavaScript dotyczy z kolei kodu działającego w interfejsie sklepu.
Wybór interfejsu powiąż z miejscem działania kodu i rodzajem przesyłanych danych¹⁰.

API IdoSell dobieraj do sposobu działania konkretnej integracji. Tych dwóch interfejsów nie należy traktować jako zamiennych.

Integracja IdoSell z Base.com: możliwe korzyści dla obsługi sklepu

Integracja IdoSell z Base.com może zmniejszyć ilość ręcznego przepisywania danych o tych samych zamówieniach. Zależy to od zakresu wymiany informacji między systemami. Znaczenie ma również to, który z nich zmienia status zamówienia.

Manager Zamówień Base.com oceniaj przez pryzmat procesu w sklepie: przyjmowania zamówień, ich realizacji i przekazywania informacji o wysyłce. Jeśli sklep sprzedaje także przez marketplace, czyli zewnętrzną platformę sprzedażową, przypisz każde zamówienie do właściwego kanału. Dla Bazy ERP ustal osobno, jakie dane ma otrzymywać i który system jest ich źródłem.

API Base.com i interfejs IdoSell określają techniczną stronę połączenia. Integrator, czyli oprogramowanie pośredniczące w wymianie danych, musi powiązać identyfikatory zamówień i obsłużyć nieudane przekazanie informacji.
Bez powiązania identyfikatorów aktualizacja może trafić do niewłaściwego zamówienia¹¹.

Integracja IdoSell z Base.com ma sens, gdy odpowiada rzeczywistemu obiegowi zamówień w sklepie¹².

Ceny i warunki sprawdzone u źródeł: październik 2026.