Utwórz obiekt api:
data_adapter = PaczkomatyInpost::FileAdapter.new(path_to_folder)
@api = PaczkomatyInpost::InpostAPI.new(username,password,data_adapter)
W przypadku problemów z połączeniem się z API Paczkomatów gem zaalarmuje o problemie w postaci wywołania Timeout::Error z wiadomością o braku połączenia.
API obsługuje metody opisane poniżej.
Pobiera podstawowe parametry systemu Paczkomaty. Zapisane są one w postaci hashu w @api.params. Parametry to:
Sprawdzenie czy lista lokalnie zapisanych paczkomatów nie jest przedawniona. Do sprawdzenia wykorzystuje parametr @api.params[:last_update]. Jeśli przekazana zostanie wartość true jako parametr przy wywołaniu to metoda uaktualni najpierw parametry z systemu InPost Paczkomaty.
Analogicznie jak sprawdzanie listy paczkomatów, metoda ta sprawdza lokalnie zapisane cenniki.
Ściąga kompletną listę Paczkomatów i zapisuje ją we wskazanym data adapterze.
Pobiera cennik i zapisuje go w adapterze.
Wyświetlenie paczkomatów w postaci tablicy zawierającej hashe z parametrami paczkomatów.
Przykład paczkomatu:
machine = {
"name" => "GDY028",
"street" => "Morska",
"buildingnumber" => "290",
"postcode" => "81-002",
"town" => "Gdynia",
"latitude" => "54.5505",
"longitude" => "18.42789",
"paymentavailable" => true,
"operatinghours" => "Paczkomat: 24/7",
"locationdescription" => "Stacja paliw LUKOIL po prawej stronie w kierunku Rumi",
"paymentpointdescr" => "Płatność kartą wyłącznie w paczkomacie. Dostępność: 24/7",
"partnerid" => 2,
"paymenttype" => 2,
"type" => "Pack Machine"
}
Możliwe opcje do przekazania to :town oraz :paymentavailable. W przypadku wskazania miasta - tylko paczkomaty z danego miasta zostaną wymienione. Paymentavailable określa czy wyświetlane paczkomaty mają obsługiwać pobranie.
Przykład:
@api.inpost_get_machine_list(:town => 'Gdynia', :paymentavailable => true)
Metoda zwraca hash zawierający informacje o płatnościach takich jak: minimalny koszt dodatkowy nadania przesyłki za probraniem (on_delivery_payment), maksymalny koszt dodatkowy nadania przesyłki za pobraniem (on_delivery_limit), procentowej wartości pobrania (on_delivery_percentage), ceny przzesyłek o standardowych wielkościach A, B oraz C. Ceny podane są w PLN.
Dodatkowo klucz insurence zawiera hash z informacjami na temat cennika ubezpieczeń dla poszczególnych limitów kwoty ubezpieczenia.
Przykład:
prices = {
"on_delivery_payment" => "3.50",
"on_delivery_percentage" => "1.80",
"on_delivery_limit" => "5000.00",
"A" => "6.99",
"B" => "8.99",
"C" => "11.99",
"insurance" => {"5000.00" => "1.50", "10000.00" => "2.50", "20000.00" => "3.00"}
}
Tablica zawierająca nazwy miejscowości, w których znajdują się Paczkomaty InPost.
Zwraca tablice zawierającą 3 najbliższe paczkomaty dla przekazanego kodu pocztowego. Przyjmuje również opcjonalny parametr paymentavailable zawężający wyszukiwanie do paczkomatów obsługujących pobranie.
Sprawdza czy wskazany email znajduje się w bazie użytkowników Paczkomatów InPost. W przypadku odnalezienia zwraca hash z informacjami na temat preferowanych paczkomatów:
{"preferedBoxMachineName" => "KRA010", "alternativeBoxMachineName" => "AND039"}
Jeśli użytkownika nie odnaleziono, zwrócony zostaje błąd:
{"error" => {"OtherException" => "Klient nie istnieje paczkomaty_test@example.com"}}
Metoda przygotowuje paczkę do wysyłki (zwraca obiekt klasy InpostPack). Wymagane parametry to:
Poza tym dopuszczalne są opcje:
Przykład utworzenia:
sender = {:name => 'Sender', :surname => 'Tester', :email => 'test@testowy.pl', :phone_num => '578937487',
:street => 'Test Street', :building_no => '12', :flat_no => nil, :town => 'Test City',
:zip_code => '67-248', :province => 'pomorskie'}
pack = @api.inpost_prepare_pack('pack_1', 'test01@paczkomaty.pl', '501892456', 'KRA010',
'B', '1.5', '10.99', :customer_ref => 'testowa przesyłka', :sender_address => sender)
Rejestruje paczki do wysłania w systemie Paczkomaty. Jako packs_data przekazana może być pojedynczy obiekt klasy InpostPack lub ich tablica. Dozwolone opcje:
Metoda zwraca hash z przypisanymi packcode dla poszczególnych paczek (identyfikatorami są temp_id). W przypadku błędu przy danej paczce zwracany jest typ oraz opis błędu.
Przykład zwróconej wartości:
{
"pack_1"=>
{
"packcode" => "622222042330624327700110"
},
"pack_2"=>
{
"error_key" => "IllegalPackType",
"error_message" => "Illegal or empty pack type."
}
}
Zwraca status przesyłki dla wskazanego packcode. Dopuszczalne zwracane wartości:
Przykłady zwracanych wartości:
# Prawidłowy packcode
{"status"=>"Prepared"}
# Błędny packcode
{"error" => {"PACK_NO_ERROR" => "Błędny numer paczki"}}
Metoda umożliwia anulowanie paczki będącej w statusie Created (nieopłacone).
Zwraca true w przypadku anulowania, false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Zmienia gabaryty wskazanej paczki. Paczka musi posiadac status Created by operacja powiodła się. Dopuszczalne wartości dla packsize to 'A', 'B' oraz 'C'.
Zwraca true w przypadku zmiany, false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Zmienia status paczki ze statusu Created do Prepared lub CustomerDelivering (dla paczek do samodzielnego nadania) pobierając jednocześnie opłatę za nadanie. Tylko paczki w statusie Prepared lub CustomerDelivering mogą zostać nadane.
Zwraca true w przypadku zmiany, false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Umieszcza dodatkową informację na etykiecie. Sugerowane zastosowanie to wydruk numeru zamówienia z systemu klienta, aby ułatwić naklejenie właściwej etykiety na odpowiednią paczkę.
Zwraca true w przypadku poprawnego wygenerowania etykiety, false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Pobiera etykietę do umieszczenia na paczce w formacie PDF. Dopuszczalne opcje to:
Zwraca true w przypadku prawidłowego ściągnięcia i zapisania etykiety (nazwa pliku tworzona przy użyciu wskazanego packcode), false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Podobnie jak poprzedniczka pozwala pobrać etykietę dla paczki, z tą różnicą iż można do niej przekazać większą liczbą packcode'ów w postaci tablicy. Dopuszczalne opcje to również:
Zwraca true w przypadku prawidłowego ściągnięcia i zapisania etykiety (nazwa pliku tworzona przy użyciu przekazanych packcode'ów), false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Pobiera potwierdzenia nadania paczek do wysłania w formacie PDF. Dopuszczalne dodatkowe opcje to:
Zwraca true w przypadku prawidłowego ściągnięcia i zapisania potwierdzenia (nazwa pliku tworzona przy użyciu przekazanych packcode'ów), false w przeciwnym razie oraz błąd w postaci String'a w przypadku błędnych danych.
Metoda umożliwia zdalną rejestrację klienta w systemie Paczkomaty 24/7. Wymagane parametry:
Parametry opcjonalne:
W przypadku błędu zwrócony zostanie jako wiadomość (String). W przypadku udanego załóżenia konta zwrócony zostanie podany adres mailowy klienta w postaci String'a, a klient otrzyma email z informacją o rejestracji.
Zwraca informacje o zrealizowanych transakcjach pobraniowych (collect on delivery). Dopuszczalne opcje:
Zwraca false w przypadku problemów z uzyskaniem odpowiedzi. String z błędem w przypadku zwróconego błędu z API Paczkomatów 24/7. Prawidłowo zakończona operacja zwraca hash zawierający kolejne paczki:
{
:packcode => {
:amount => kwota_pobrania,
:posdesc => opis_punktu_pos,
:packcode => numer_paczki,
:transactiondate => data_transakcji
}
}
Metoda pozwala uzyskać informację na temat paczek wygenerowanych w systemie przez określonego nadawcę. Dopuszczalne opcje:
Zwraca hash z odnalezionymi przesyłkami. Kluczami do poszczególnych paczek są packcode'y. W przypadku braku paczek określonych parametrami metoda zwraca pusty Hash. Struktura zwróconej paczki wygląda następująco:
{
:packcode => {
:alternativeboxmachinename => paczkomat_alternatywny,
:amountcharged => kwota_pobrana_z_konta_nadawcy,
:calculatedchargeamount => cena_paczki,
:creationdate => data_utworzenia_paczki,
:customerdeliveringcode => kod_samodzielnego_nadania,
:is_conf_printed => czy_potwierdzenie_nadania_wydrukowane,
:labelcreationtime => data_wydruku_etykiety,
:labelprinted => czy_etykieta_wydrukowana,
:ondeliveryamount => kwota_pobrania,
:packcode => kod_paczki,
:packsize => gabaryt_paczki,
:preferedboxmachinename => docelowy_paczkomat,
:receiveremail => email_odbiorcy,
:status => status_paczki
}
}
W przypadku błedu zwraca false lub wiadomość o błedzie w postaci String'a.
Dalsze testy w drodze :)
FAQs
Unknown package
We found that paczkomaty_inpost demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.