Dokumentacja API (kolekcja Postman)

Publiczne API PowerHub pozwala połączyć Twój sklep, system ERP albo własne narzędzia bezpośrednio z platformą. Kompletna, interaktywna dokumentacja wszystkich żądań dostępna jest jako kolekcja PowerHub API w serwisie Postman.

Czym jest dokumentacja API w Postman

Dokumentacja API PowerHub jest opublikowana jako kolekcja w Postman, czyli interaktywny katalog wszystkich żądań, które udostępnia platforma. Każde żądanie ma opis, komplet parametrów, przykładowe dane wejściowe oraz przykładową odpowiedź, więc zamiast czytać suchą specyfikację, od razu widzisz, jak wygląda konkretne wywołanie i co zwraca.

Kolekcję otwierasz w przeglądarce, a w razie potrzeby importujesz do własnego środowiska Postman jednym kliknięciem. To wygodny punkt startu zarówno do szybkiego sprawdzenia, jak działa dane wywołanie, jak i do budowy pełnej integracji.

› PowerHub API w Postman
Interaktywna dokumentacja wszystkich żądań publicznego API PowerHub.
https://documenter.getpostman.com/view/15377351/2sB2x2JZV8

Co można uzyskać dzięki integracji

Integracja z API pozwala zautomatyzować obieg danych między PowerHub a Twoimi systemami, bez ręcznego przepisywania. Najczęstsze zastosowania:

  • Synchronizacja zamówień: pobieranie nowych zamówień, odczyt i zmiana statusów, aktualizacja danych realizacji.
  • Katalog i cennik: masowe zakładanie i aktualizacja produktów, wariantów, cen oraz grup cenowych.
  • Magazyn: odczyt stanów, rejestrowanie ruchów magazynowych, obsługa dostaw i przesunięć.
  • Dokumenty sprzedaży: wystawianie faktur i innych dokumentów oraz pobieranie ich danych.
  • Wysyłka i realizacja: tworzenie przesyłek, pobieranie etykiet, obsługa punktów odbioru.
  • Klienci: synchronizacja bazy klientów, adresów i zgód.
  • Powiadomienia wychodzące: rejestracja adresów, które mają odbierać zdarzenia z PowerHub w czasie rzeczywistym.

Jak zacząć

1

Wygeneruj klucz API

Klucz utworzysz w panelu, w ustawieniach kluczy API. Działa w kontekście Twojej organizacji.

2

Otwórz kolekcję w Postman

Wejdź na dokumentację PowerHub API i przejrzyj dostępne żądania pogrupowane tematycznie.

3

Ustaw adres bazowy i klucz

W środowisku Postman podstaw adres bazowy API oraz swój klucz, aby wysyłać żądania na własnych danych.

4

Wyślij pierwsze żądanie

Zacznij od odczytu listy zamówień albo produktów, żeby potwierdzić, że klucz działa i dane wracają.

Przykłady w wielu językach

Dokumentacja w Postman generuje gotowy fragment kodu dla każdego żądania w kilkudziesięciu wariantach: curl, Python, PHP, JavaScript, Node.js, Java, Go, Ruby, C#, Swift i inne. Wystarczy skopiować fragment w swoim języku i podstawić klucz.

Przykładowe pierwsze żądanie

Najprostsze wywołanie to odczyt listy zamówień z kluczem w nagłówku autoryzacji:

curl https://api.powerhub.pl/orders?limit=20 \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json"

Gdzie szukać szczegółów

Ten artykuł to ogólne wprowadzenie. Kompletny, zawsze aktualny opis pojedynczych żądań, pól i przykładów znajdziesz w kolekcji Postman. Kolejne artykuły tej kategorii opisują zasady wspólne dla całego API: uwierzytelnianie i limity, powiadomienia wychodzące oraz konwencje zasobów i operacji.

Zobacz też

Uwierzytelnianie i limity
Klucz API, nagłówki żądania, limity liczby zapytań i obsługa błędów.
Zasoby i operacje
Jednolity CRUD, filtrowanie, stronicowanie oraz pełna lista zasobów.
Powiadomienia wychodzące
Odbieranie zdarzeń z PowerHub zamiast odpytywania API w pętli.