Dokumentacja API InPost (ShipX API) pozwala zautomatyzować nadawanie i śledzenie przesyłek z poziomu własnego systemu. Poniżej zebrano informacje o ShipX API – autoryzacja, endpointy, sandbox i linki do dokumentacji.

API
ShipX API
Oficjalna nazwa API
Autoryzacja
Token Bearer
Metoda uwierzytelniania
Endpointy
5
Główne grupy funkcji

Funkcje ShipX API

API InPost daje dostęp do endpointów obsługujących przesyłki. Zamiast ręcznie wypełniać formularze u kuriera, wszystkim zarządzasz ze swojego systemu.

Funkcje ShipX API:

  • Tworzenie przesyłek: Nadawanie paczek do Paczkomatów i kurierem InPost
  • Generowanie etykiet: Pobieranie listów przewozowych w PDF
  • Śledzenie przesyłek: Statusy w czasie rzeczywistym via webhooks
  • Zarządzanie punktami: Lista Paczkomatów, punktów odbioru i POP
  • Dispatchery: Zamawianie odbioru paczek przez kuriera

Autoryzacja i dostęp do API InPost

Dostęp do ShipX API wymaga uwierzytelnienia przez Token Bearer (OAuth 2.0). Konto deweloperskie zakładasz samodzielnie albo dostajesz dane od opiekuna handlowego.

Środowisko testowe (sandbox)

Przed wdrożeniem na produkcję przetestuj integrację w sandboxie: Https://sandbox-api-shipx-pl.easypack24.net. Testy w sandboxie nie wpływają na rzeczywiste przesyłki ani rozliczenia.

Integracja z platformami e-commerce

API InPost ma gotowe wtyczki do popularnych platform sklepowych, więc nie trzeba pisać integracji od zera.

Wspierane platformy:

  • WooCommerce
  • PrestaShop
  • Magento
  • Shopify
  • BaseLinker
  • IdoSell

Dla innych platform ShipX API udostępnia dokumentację REST – integrację napiszesz w PHP, Python, Java, C# lub Node.js.

Dokumentacja ShipX API: pobierz

Oficjalna Dokumentacji API InPost zawiera opisy endpointów, parametry żądań, kody odpowiedzi i przykłady.

Oficjalna dokumentacja jest również dostępna na stronie: Docs.inpost24.com.

Jak rozpocząć integrację z API InPost?

Proces integracji z ShipX API składa się z kilku kroków: od rejestracji konta po wdrożenie produkcyjne.

Integracja z API InPost: krok po kroku

1
Rejestracja
Załóż konto i pobierz klucze
2
Sandbox
Przetestuj w sandboxie
3
Wdrożenie
Przełącz na produkcję
4
Monitoring
Monitoruj logi i błędy

Zobacz też:

Najczęściej zadawane pytania

Jak uzyskać dostęp do API InPost?

Aby uzyskać dostęp do ShipX API, należy zarejestrować konto na portalu deweloperskim InPost i wygenerować klucze autoryzacyjne. Metoda uwierzytelniania to token Bearer (OAuth 2.0). Przed wdrożeniem produkcyjnym warto przetestować integrację w środowisku sandbox.

Czy InPost udostępnia środowisko testowe (sandbox)?

Tak, InPost udostępnia środowisko testowe: https://sandbox-api-shipx-pl.easypack24.net. Testy w sandboxie nie wpływają na rzeczywiste przesyłki ani rozliczenia.

Z jakimi platformami e-commerce integruje się API InPost?

API InPost ma gotowe wtyczki do: WooCommerce, PrestaShop, Magento, Shopify, BaseLinker, IdoSell. Dokumentacja REST/SOAP pozwala też napisać własną integrację.