Integracja Apaczka przez Web API
Wycena przesyłki u kilku kurierów, wybór punktu, etykieta i zbiorczy dokument nadania z Twojego panelu. Apaczka podpisuje każde zapytanie, więc integracja jest prosta, ale wymaga precyzji.
Od wyceny do śledzenia
Kolejność wywołań Web API v2 w typowej wysyłce. Każdy krok to osobny endpoint.
Struktura usług
service_structure/Jakie usługi, opcje i typy punktów masz na koncie.
W sklepielista kurierów do koszyka
W sklepielista kurierów do koszykaWycena
order_valuation/Koszt przesyłki dla wybranych usług.
W sklepiecena dostawy w koszyku
W sklepiecena dostawy w koszykuZamówienie
order_send/Przesyłka z danymi paczki i punktem.
W sklepienumer zamówienia Apaczki
W sklepienumer zamówienia ApaczkiEtykieta
waybill/:order_id/List przewozowy do druku.
W sklepieetykieta do paczki
W sklepieetykieta do paczkiNadanie i śledzenie
turn_in/tracking/:waybill_number/Zbiorczy dokument nadania i statusy przesyłki.
W sklepiestatus w zamówieniu
W sklepiestatus w zamówieniu
Podpis każdego zapytania
Apaczka nie używa tokenów sesji. Każde zapytanie niesie podpis HMAC i datę wygaśnięcia, a podpis liczy się z tych samych danych, które idą w treści.
Cztery części, jeden ciąg
Identyfikator aplikacji, nazwa endpointu, dane JSON i data wygaśnięcia, w tej kolejności. JSON składamy raz, bo ponowne złożenie po podpisaniu zmienia znaki.
HMAC-SHA256 z App Secret
Podpis liczymy kluczem App Secret, który zostaje w ustawieniach serwera i nie trafia do przeglądarki.
Najwyżej 30 minut
Data wygaśnięcia musi być w przyszłości i najwyżej 30 minut od teraz. Liczy się od czasu serwera, więc zegar trzymamy zsynchronizowany z siecią.
Wtyczka czy integracja przez API
Na popularnych platformach zwykle wystarczy gotowe połączenie. Kod piszemy dla sklepów i systemów na zamówienie.
Usługi włączasz w konfiguracji integracji platformy.
Cenę pokazuje to, co daje gotowa integracja platformy.
Gdy cena ma się liczyć na żywo dla każdej paczki, potrzebna jest integracja przez API.
Przesyłkę zamawiasz w panelu Apaczki.
Etykietę i dokument nadania pobierasz w panelu Apaczki.
Dokumenty są w panelu Apaczki, a nie przy zamówieniu w Twoim panelu.
Statusy sprawdzasz w panelu Apaczki.
www.apaczka.pl/api/v2/POST service_structure/Usługi, opcje i to, czy trzeba zamówić kuriera, prosto z konta.
POST order_valuation/Cena dla paczki złożonej w koszyku.
Cena liczy się na żywo z wagi i wymiarów produktów w koszyku.
POST order_send/Przesyłka z danymi paczki i punktem, z Twojego panelu.
POST waybill/:order_id/List przewozowy przy pakowaniu, a turn_in/ na koniec dnia.
Etykiety i dokument nadania są przy zamówieniu w Twoim panelu.
POST tracking/:waybill_number/Śledzenie trafia do zamówienia i do panelu klienta.
Co płynie między sklepem a Apaczką
Sklep wysyła dane przesyłki, Apaczka zwraca ceny, dokumenty i statusy.
- Twój sklepCena dostawy w koszyku←order_valuation/ApaczkaWycena usług dla tej paczki
- Twój sklepPunkt wybrany przez klienta←points/:typeApaczkaPunkty nadania i odbioru danego typu
- Twój sklepSpakowane zamówienie→order_send/ApaczkaZamówienie przesyłki
- Twój sklepEtykieta przy pakowaniu←waybill/:order_id/ApaczkaList przewozowy do druku
- Twój sklepDokument nadania na koniec dnia←turn_in/ApaczkaZbiorcze potwierdzenie nadania jako PDF
- Twój sklepStatus w zamówieniu←tracking/:waybill_number/ApaczkaStatusy przesyłki, sprawdzane okresowo
Usługi i godziny odbioru
Listę usług, opcji i typów punktów bierzemy z konta w Apaczce, a godziny odbioru z osobnego endpointu, więc koszyk i ekran nadania zawsze pokazują to, co masz naprawdę.
Usługi z konta, nie z kodu
service_structure/Identyfikatory usług i opcji bierzemy z tego endpointu przy każdej synchronizacji, a nie wpisujemy na sztywno.
Kurier możliwy albo wymagany
service_structure/Struktura usług mówi, czy odbiór kurierem jest możliwy albo konieczny. Od tego zależy ekran nadania w panelu.
Godziny odbioru
pickup_hours/Godziny, w których kurier może odebrać paczki, przychodzą z Apaczki, a magazyn widzi je przy nadaniu.
Najczęstsze pytania o Apaczkę
Odpowiedzi o cenie dostawy, etykietach, wyborze agregatora i wycenie.
Czytaj dalej
Przewoźnicy i platformy, z którymi łączymy Apaczkę.
Jak dziś liczysz koszt dostawy?
Napisz, na czym działa sklep i z jakich kurierów korzystasz. Odpowiemy w godzinę z pytaniami i wyceną.


