Page tree
Skip to end of metadata
Go to start of metadata


Środowisko produkcyjne

Adres środowiska produkcyjnego  https://api-shipx-pl.easypack24.net


Aby otrzymać token autoryzacyjny do api ShipX, skorzystaj z formularza pod linkiem: https://inpost.pl/formularz-wsparcie

Na tej stronie

 

Środowisko testowe

Adres środowiska testowego: https://sandbox-api-shipx-pl.easypack24.net



Nagłówki zapytania

Podczas wykonywania zapytania można określić następujące nagłówki

NagłowekOpis
AuthorizationNagłówek autoryzacji, w którym należy przesyłać wszelkie dane związane z autoryzacją. Szczegóły zostały opisane w rozdziale Autoryzacja.
X-User-AgentNagłówek ten pozawala na określenie nazwy klienta/platformy i/lub innych informacji z nim związanych.
X-User-Agent-VersionNagłówek ten pozwala na określenie wersji klienta/platformy, który wykonuje zapytania. Jego zawartość nie wpływa na funkcjonowanie API.
X-Request-IDNagłówek ten pozwala na określenie identyfikator zapytania. Jest on przydatny przy debugowaniu błędów i problemów, które mogą zdarzyć się przy integracji z API. Jego podanie nie wpływa na funkcjonowanie API.
Accept-Language

Nagłówek pozwala na zmianę formatu komunikatów błędów. Dostępne:

  • keys (some_error_message)
  • en_GB (Some error message)
  • pl_PL (Przykładowy komunikat błędu)

Nagłówki odpowiedzi

W odpowiedzi serwer zwraca następujące nagłówki:

NagłówekOpis
X-Request-IDIdentyfikator zapytania. Przydatny podczas debugowania problemów z API.
W przypadku gdy zostanie on określony podczas zapytania, API nie będzie generowało własnego IID, a w odpowiedzi zostanie zwrócony ten podany podczas zapytania. 

Kolekcje

Atrybuty kolekcji

AtrybutTypOpis
hrefStringAbsolutny adres URL do kolekcji.
countIntegerŁączna ilość elementów kolekcji.
pageIntegerAktualna strona wyników kolekcji.
per_pageIntegerIlość wyników (na stronę) zwracanych w odpowiedzi.
itemsArrayElementy kolekcji.

Przykład kolekcji w formacie JSON:

{
	"href": "https://api-pl-shipx.easypack24.net/v1/points",
	"count": 1024,
	"page": 10,
	"per_page": 100,
	"items": [
		{
			"href": "https://api-shipx-pl.easypack24.net/v1/points/KRA010",
			"id": "KRA010",
			... other resource's params ...
		}
	]
}


Stronicowanie

Kolekcje wspierają stronicowanie (chyba, że zostało zaznaczone inaczej w dokumentacji właściwej dla zasobu).

Przewijanie po kolejnych stronach kolekcji obywa się poprzez przekazanie w zapytaniu parametrów (page) i/lub (page_page). Przykład zapytania:

GET /v1/points?page=10 HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json

Autoryzacja

Wszystkie zapytania wysyłane do serwera wymagają podania prawidłowego i ważnego access tokenu, który należy do określonego właściciela (owner) organizacji.

Access token należy przekazać w nagłówku Authorization.
Przykład zapytania:

GET /v1/users HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer W-TYM-MIEJSCU-NALEZY-UMIESCIC-TOKEN

Błędy

Przykład błędu

HTTP/1.1 400 Bad Request
Content-Type: application/json
 
{
	"status": 400,
	"error": "invalid_parameter",
	"description": "Passed unsupported value (value of the parameter here) to parameter (parameter name)",
	"details": null
}

Poniżej znajduje się lista kluczy błędów, które mogą wystąpić.

KluczOpis
resource_not_foundSzukany zasób nie został odnaleziony.
access_forbiddenDostęp do określonego zasobu jest zabroniony.
invalid_parameterPrzekazano niepoprawną wartość dla określonego parametru w URI. Szczegóły dostępne pod kluczem description odpowiedzi błędu.
validation_failedBłąd walidacji. Dane przesłane w ciele zapytania metodą POST są niepoprawne. Szczegóły błędu zawarte w odpowiedzi pod kluczem details. Zobacz poniżej przykład błędu walidacji.
offer_expiredZakupienie oferty jest niemożliwe, ponieważ upłynął termin jej ważności.


Przykład błędu validation_failed

HTTP/1.1 400 Bad Request
Content-Type: application/json
 
{
	"status": 400,
	"error": "validation_failed",
	"description": "Some of data sent in payload are invalid. Check details for more information.",
	"details": {
		"email": ["invalid"]
	}
}

Obit details zawiera w tym przypadku kolekcję, w której klucze odpowiadają nazwom przesłanych w ciele zapytania parametrów, natomiast wartości to tablica z kluczami określającymi jakie błędy walidacji wystąpiły dla określonego parametru.

Możliwe błędy walidacji to:

Błąd walidacjiOpis
requiredWartość dla określonego parametru jest wymagana.
too_shortIlość znaków zbyt mała. Sprawdź szczegóły w dokumentacji określonego zasobu.
too_longIlość znaków zbyt duża. Sprawdź szczegóły w dokumentacji określonego zasobu.
not_a_numberWprowadzona wartość powinna być liczbą.
not_an_integerWprowadzona wartość powinna być liczbą całkowitą.
invalidWprowadzona wartość jest niepoprawna. Sprawdź szczegóły w dokumentacji określonego zasobu.
  • No labels