Kody odpowiedzi HTTP
Kody odpowiedzi HTTP, które mogą wystąpić w odpowiedzi od serwera:
...
Błędy
W przypadku wystąpienia błędu, API zwraca obiekt błędu, który zawiera następujące atrybuty:
...
Prosty, łatwy do zrozumienia opis błędu.
| Note |
|---|
Opis błędu może ulegać zmianie i nie należy opierać na nim warunków w kodzie. |
...
Przykładowa odpowiedź:
| Code Block |
|---|
HTTP/1.1 404 Not Found
{
"status": 404,
"error": "resource_not_found",
"message": "Resource you are looking for are not found",
"details: {}
} |
W przypadku zapytania przesłanego metodą POST lub PUT mogą wystąpić błędy walidacji. Szczegóły na ich temat umieszczane są pod atrybutem details w odpowiedzi:
| Code Block |
|---|
HTTP/1.1 400 Bad Request
{
"status": 400,
"error": "validation_failed",
"message": "Data sent by POST or PUT request are not valid. Check details for more info",
"details: {
"name": ["required", "too_short"],
"post_code": ["invalid_format"]
}
} |
Kluczami obiektu details są nazwy atrybutów przesłanych metodą POST lub PUT, dla których wystąpiły błędy walidacji. Natomiast ich wartości to tablica kluczy błędów, które są prawdziwe dla przesłanej wartości. Poniżej opisana jest lista generycznych kluczy błędów walidacji.
Klucze błędów
Poniższa tabela przedstawia klucze błędów, które mogą zostać zwrócone przez serwer, wraz z możliwymi kodami HTTP:
| Klucz błędu | Kod HTTP | Opis |
|---|---|---|
resource_not_found | 404 | Szukany zasób nie został odnaleziony, np. adres URL jest niepoprawny lub zasób nie istnieje. |
validation_failed | 400 | Przy przesyłaniu danych metodą POST lub PUT wystąpiły błędy w walidacji. Szczegółowe błędy walidacji zawarte są pod atrybutem details. |
unauthorized | 401 | Dostęp do zasobu jest niemożliwy ponieważ zapytanie nie zostało podpisane kluczem access token. |
access_forbidden | 403 | Dostęp do określone zasobu jest zabroniony dla tego zapytania (np. z powodu braku lub niewłaściwego zakresu uprawnień). |
Klucze błędów walidacji
Poniższa tabela przedstawia generyczne klucze błędów walidacji, które zwracane są pod atrybutem details dla odpowiedzi błędu validation_failed:
| Klucz błędu | Opis |
|---|---|
required | Podanie wartości jest wymagane. |
invalid | Podana wartość jest nieprawidłowa. Szczegóły w dokumentacji opisującej zasób. |
too_short | Podana wartość jest zbyt krótka. Szczegóły w dokumentacji opisującej zasób. |
too_long | Podana wartość jest zbyt długa. Szczegóły w dokumentacji opisującej zasób. |
too_small | Podana wartość jest zbyt mała. Dotyczy głównie wartości liczbowych. Szczegóły w dokumentacji opisującej zasób. |
too_big | Podana wartość jest zbyt duża. Dotyczy głównie wartości liczbowych. Szczegóły w dokumentacji opisującej zasób. |
invalid_format | Podana wartość ma niepoprawny format, np. gdy w pole numer telefonu zostały wpisane cyfry. Szczegóły w dokumentacji opisującej zasób. |
...
Właściwe wdrożenie usług InPost na stronie internetowej
Zadbaj o poprawną ekspozycję usług InPost, dzięki czemu:
Kupujący szybko rozpoznają, że dokonując zakupu w Twoim sklepie mogą skorzystać z dostarczenia zamówienia przez firmę, której usług poszukują i do której mają zaufanie, co bezpośrednio przyczynia się do decyzji zakupowych Klientów.
Przy prawidłowym zastosowaniu mapy i listy urządzeń Paczkomat – Geowidget – pomagasz swoim Klientom szybko wyszukać pożądane przez nich miejsce dostawy zamówienia, skupiając ich uwagę na tym zadaniu, unikając rozproszeń i zagubienia się w procesie zakupowym.
Poradnik skutecznej implementacji dostaw InPost w koszyku e-commerce
Zapoznaj się z dedykowanym materiałem wspierającym, dotyczącym poprawnej implementacji usług InPost. Gromadzi on w jednym miejscu informacje w zakresie aktualnego brandingu InPost, wytyczne odnośnie implementacji przyjaznego wyszukiwania automatów Paczkomat i PaczkoPunktów oraz dobre praktyki, warte stosowania przy budowaniu pozytywnego user experience wśród Kupujących online.