Download the PHP package allekurier/api_v2 without Composer
On this page you can find all versions of the php package allekurier/api_v2. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api_v2
Biblioteka kliencka API dla AlleKuriera i Wygodnych Zwrotów
Wymagania
Biblioteka ma następujące wymagania:
- PHP 7.4 lub nowsza wersja;
- rozszerzenie "ext-curl" do PHP;
- rozszerzenie "ext-json" do PHP.
Instalacja
W celu zainstalowania biblioteki należy użyć następującego polecenia:
Korzystanie z API
Autoryzacja
Wygenerowanie tokenu
W celu korzystania z komend API należy najpierw się zalogować. Logowanie powoduje wygenerowanie tokenu, który następnie jest używany przy wywoływaniu każdej innej komendy.
Token jest ważny 2 tygodnie. Po tym czasie należy ponownie się zalogować.
Zapytanie
https://api.allekurier.pl/user/login
gdzie:
EMAIL_KLIENTA: E-mail klienta, na który zarejestrowane jest jego konto.HASLO_KLIENTA: Hasło przypisane do konta klienta.
Odpowiedź
W odpowiedzi zwracanych jest parę pól z danymi, z których najważniejszymi są następujące:
token: Token autoryzacyjny.
Przykład:
PHP
gdzie:
EMAIL_KLIENTA: E-mail klienta, na który zarejestrowane jest jego konto.HASLO_KLIENTA: Hasło przypisane do konta klienta.
Jeżeli nie zostały zwrócone błędy, to $loginData zawiera dane zwrócone w odpowiedzi. Obecnie jest to token autoryzacyjny, który można pobrać przy pomocy metody getToken(), tj.:
Używanie tokenu
W celu nawiązania połączenia z API należy podać token, który został wygenerowany poprzez wywołanie komendy do logowania.
Jeżeli klient jest właścicielem sklepu korzystającego z usługi Wygodnych Zwrotów, to może podać również kod sklepu, aby dla komend API, które z niego korzystają, uzyskać wyniki, które nie dotyczą konta klienta, ale wybranego sklepu.
Dane autoryzacyjne muszą znajdować się w nagłówku HTTP w postaci:
Authorization: Musi być typu "BEARER" i zawierać token.MailBox-Code: Jeżeli istnieje, to musi zawierać kod sklepu, którego dotyczy wywołanie komendy.
W niniejszej bibliotece można te dane uzyskać wywołując następujący kod:
gdzie:
TOKEN_AUTORYZACYJNY: Token uzyskany po zalogowaniu przez klienta.KOD_SKLEPU_KLIENTA: Kod sklepu, dla którego ma zostać wywołana komenda API.
Zwracane dane
Zwracane dane są zawsze w formacie JSON. W celu sprawdzenia czy nie wystąpił błąd można sprawdzić jeden z następujących elementów:
failure: Jest ustawione natrue, gdy zwrócony został błąd.successful: Jest ustawiony natrue, gdy błąd nie wystąpił.
Oba elementy są zawsze zwracane w każdej odpowiedzi z API.
W przypadku wystąpienia błędu zwracane są następujące elementy:
errors: Tablica błędów.mainError: Główny błąd.
Każdy z błędów - czy to w tablicy errors czy w kluczu mainError - zawiera następujące elementy:
message: Opis błędu.code: Kod błędu. Może zwrócić wartośćnull.level: Poziom błędu: Dostępne są poziomy:notice,warning,critical.
Przykład:
Komendy
Informacje o wszystkich dostępnych komendach znajdują się pod adresem: https://api.allekurier.pl/api/doc
Pobranie danych przesyłki
PHP
gdzie:
NUMER_SLEDZENIA: Numer śledzenia przesyłki lub numer, który został zeskanowany na liście przewozowym.
cURL
gdzie:
TOKEN_AUTORYZACYJNY: Token autoryzacyjny.NUMER_SLEDZENIA: Numer śledzenia przesyłki lub numer, który został zeskanowany na liście przewozowym.
Pobranie przesyłek wysłanych w danym dniu
PHP
gdzie:
DATA: Data w formacie Y-m-d wg, której pobierana jest lista przesyłek. Gdy null- dzisiejsza data.
cURL
gdzie:
TOKEN_AUTORYZACYJNY: Token autoryzacyjny.DATA: Data w formacie Y-m-d wg, której pobierana jest lista przesyłek. Gdy null- dzisiejsza data.
