Page Comparison

W tym rozdziale znajdziesz informacje dotyczące autoryzacji w komunikacji z InPost Pay oraz konfiguracji konta Merchanta i generowania dostępów (client_id i client_secret).

Na tej stronie:

Table of Contents

minLevel	1
maxLevel	6
include
outline	false
indent
exclude
type	list
class
printable	false

Autoryzacja

Do uwierzytelniania komunikacji klienta z InPost Pay (Basket App) wykorzystany jest standard OAuth 2.0. W przypadku komunikacji service to service – bez kontekstu zalogowanego użytkownika wykorzystany jest client_credentials flow a OAuth (https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/).

Merchant otrzymuje swój client_id i client_secret

Info
Client_id i client_secret dla środowiska produkcyjnego Merchant generuje poprzez panel Merchanta zgodnie z instrukcją. Client_id i client_secret dla środowiska sandbox Merchant otrzymuje od InPost po wysłaniu zgłoszenia poprzez formularz kontaktowy zgodnie z instrukcją.

Pobiera access token
Podpisuje każdy request. Access token należy przekazać w nagłówku Authorization: Bearer W-TYM-MIEJSCU-NALEZY-UMIESCIC-TOKEN
Serwer zasobów weryfikuje token i identyfikuje klienta

Info
Wszystkie zapytania wysyłane do serwera wymagają podania prawidłowego i ważnego access tokenu, który należy do określonego Użytkownika.

Info
Wygenerowany token ma określoną ważność (zdefiniowana w expires_in, która jest zwracana wraz z tokenem) i nie ma konieczności pobierania nowego tokena przy każdym zapytaniu.

Token endpoint jest stały i może być parametrem konfiguracyjnym po stronie klienta:

środowisko produkcyjne
https://login.inpost.pl/auth/realms/external/protocol/openid-connect/token
środowisko sandbox
https://sandbox-login.inpost.pl/auth/realms/external/protocol/openid-connect/token

Pobranie tokenu

Request

Code Block

language	json

curl --location 'https://sandbox-login.inpost.pl/auth/realms/external/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=sandbox' \
--data-urlencode 'client_secret=qwertyuiop' \
--data-urlencode 'grant_type=client_credentials'

Response

Code Block

language	json

{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiw...",
    "expires_in": 300,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
    "scope": "api:inpostpay"
}

Warning

Błędy jakie mogą wystąpić podczas generowania tokenu:

Invalid client credentials - W przypadku podania błędnego client_id
Invalid client secret - W przypadku podania błędnego client_secret
Missing form parameter: grant_type - W przypadku niepodania grant_type:client_credentials

Przykład implementacji w języku PHP

Tworzymy interface serwisu, który będzie odpowiedzialny za pobranie bearer access token.

Code Block

language	php

<?php

declare(strict_types=1);

namespace Iteo\InpostPayClient\Client;

use Iteo\InpostPayClient\SDK\Core\Exceptions\InpostPayEndpointException;

/**
 * Interface used for creating bearer token, needed to communication with Inpost Pay.
 */
interface InpostPayBearerServiceInterface
{
    /**
     * Method that creating bearer access token for given merchant credentials.
     *
     * @return string Bearer access token
     *
     * @throws InpostPayEndpointException
     */
    public function getBearerToken(): string;
}

View file

name	autoryzacjaBearerServiceInterface.txt

Tworzymy exception, który będziemy zwracali w przypadku niepowodzenia pobrania tokenu.

Code Block

language	php

<?php

declare(strict_types=1);

namespace Iteo\InpostPayClient\SDK\Core\Exceptions;

class InpostPayEndpointException extends \Exception
{
    final public function __construct(string $message = '', int $code = 0, \Throwable $previous = null)
    {
        parent::__construct($message, $code, $previous);
    }

    public static function createClientException(\Throwable $throwable): self
    {
        return new static(
            sprintf('InpostPayClient, error occurred when creating http client with bearer token. Exception message: %s', $throwable->getMessage()),
            $throwable->getCode(),
            $throwable
        );
    }
}

View file

name	autoryzacjaException.txt

Tworzymy implementację serwisu, który pobiera access token przy użyciu metody getBearerToken.

Code Block

language	php

<?php

declare(strict_types=1);

namespace Iteo\InpostPayClient\Client;

use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Provider\GenericProvider;
use Iteo\InpostPayClient\SDK\Core\Exceptions\InpostPayEndpointException;

/**
 * PHP Bearer Service implementation used for creating bearer token, needed to communication with Inpost Pay.
 */
final class InpostPayBearerService implements InpostPayBearerServiceInterface
{
    private string $clientId;
    private string $clientSecret;
    private string $urlAccessToken;
    private ?string $urlAuthorize;
    private ?string $urlResourceOwnerDetails;
    
    //Zamienić w zależności od środowiska
    private const URL_ACCESS_TOKEN = 'https://sandbox-login.inpost.pl/auth/realms/external/protocol/openid-connect/token';

    public function __construct(string $clientId, string $clientSecret, string $urlAccessToken = self::URL_ACCESS_TOKEN, string $urlAuthorize = null, string $urlResourceOwnerDetails = null)
    {
        $this->clientId = $clientId;
        $this->clientSecret = $clientSecret;
        $this->urlAccessToken = $urlAccessToken;
        $this->urlAuthorize = $urlAuthorize;
        $this->urlResourceOwnerDetails = $urlResourceOwnerDetails;
    }

    /**
     * {@inheritdoc}
     */
    public function getBearerToken(): string
    {
        $provider = new GenericProvider([
            'clientId' => $this->clientId,
            'clientSecret' => $this->clientSecret,
            'urlAuthorize' => $this->urlAuthorize,
            'urlAccessToken' => $this->urlAccessToken,
            'urlResourceOwnerDetails' => $this->urlResourceOwnerDetails,
        ]);

        try {
            return $provider->getAccessToken('client_credentials')->getToken();
        } catch (IdentityProviderException $exception) {
            throw InpostPayEndpointException::createClientException($exception);
        }
    }
}

View file

name	autoryzacjaBearerServiceInterface.txt

W celu wykorzystania OAuth2.0 użyta została biblioteka: https://packagist.org/packages/league/oauth2-client?query=https%3A%2F%2Fpackagist.org%2Fpackages%2Fleague%2Foauth2-client%3Ftype%3Dcontao-module%26page%3D40&type=contao-module#2.7.0

Konfiguracja konta Merchanta - środowisko produkcyjne

Aby uzyskać dostępy do środowiska produkcyjnego podpisz umowę Umowa o obsługę i rozliczanie transakcji. Jeśli jeszcze nie podpisałeś umowy skontaktuj się ze swoim przedstawicielem handlowym InPost lub skorzystaj z formularza zamieszczonego w sekcji "Dla Biznesu" w zakładce "Oferta InPost Pay".

Po podpisaniu umowy :

Zaloguj

zaloguj się do serwisu LINK używając danych do logowania w Manager Paczek (system do obsługi umowy logistycznej InPost).

UWAGA! Uzupełnienie wszystkich informacji jest niezbędne do wygenerowania dostępów (Client_ID oraz Client_Secret) na środowisko produkcyjne usługi InPost Pay

Po zalogowaniu zobaczysz menu z poniższymi kategoriami
Image Removed
Przejdź do zakładki
Image Removed
Dodaj w niej informacje o Twoim sklepie internetowym, które użytkownicy zobaczą w aplikacji InPost mobile podczas dokonywania zakupów. Kliknij przycisk EDYTUJ, aby edytować informacje.

Image Removed

Nazwa merchanta – to bardzo istotne pole, w które powinieneś wpisać nazwę sklepu, jaką klienci zobaczą w aplikacji InPost mobile podczas robienia zakupów.

PRZYKŁAD WIDOKU W APLIKACJI:

Image Removed

Logo sklepu – to logo, które klienci zobaczą w aplikacji InPost mobile podczas robienia zakupów, zaraz obok nazwy Twojego sklepu. Logo, powinno być dostosowane do maksymalnej szerokości 72px lub maksymalnej wysokości 32px, aby zapewnić czytelność i odpowiednią wizualizację na różnych urządzeniach. Dodatkowo, prosimy o dostarczenie logo w dwóch wersjach kolorystycznych, light mode oraz dark mode, zoptymalizowane tak, aby zapewnić czytelność i estetykę na jasnym i ciemnym tle. Dzięki dostarczeniu logo w obu tych wersjach kolorystycznych, zapewnimy spójność i estetykę, niezależnie od tego, czy użytkownik korzysta z trybu jasnego czy ciemnego aplikacji. W pole wklej link do swojego logo i użyj przycisku Załaduj – wówczas po prawej stronie zobaczysz poprawnie załadowane logo Twojego sklepu.

Image Removed

Komunikacja z backendem – to link, który umożliwi wymianę informacji między Twoim sklepem, a naszą usługą.

Jeśli korzystasz z integracji API wklej tam swój dedykowany link.
Jeśli korzystasz z technologii wtyczkowej podaj tu po prostu link do Twojego sklepu

Dane kontaktowe - poniższe dane będą prezentowane w szczegółach Twojego sklepu, klienci zobaczą je w aplikacji InPost mobile podczas robienia zakupów.

Numer komórkowy (wymagany)
Numer stacjonarny (niewymagany)
Email do kontaktu (wymagany)
Link do formularza kontaktowego (niewymagany)

Po uzupełnieniu wszystkich danych kliknij przycisk Zapisz zmiany

Image Removed

Przejdź do zakładki Konfiguracja klienta API

Image RemovedU góry w prawym rogu wybierz przycisk Dodaj nowy sklep

Image Removed

Wpisz nazwę Twojego sklepu (ta nazwa jest widoczna tylko dla Ciebie, klienci jej nie zobaczą)

Image Removed

Wprowadź nazwę sklepu i kliknij Zapisz

Na ekranie pojawią się dostępy do środowiska produkcyjnego – skopiuj je i pamiętaj – nie udostępniaj ich nikomu!

Image Removed

Dodany sklep będzie widoczny w tej zakładce wraz z Client_ID, jeśli zapomnisz Client_Secret możesz je odzyskać klikając przycisk Resetuj

Image Removed

W ostatniej zakładce:

Image Removed

Możesz uzyskać secret do Merchant Transaction API (nie każdy potrzebuje tej funkcji) – całościowy opis tej usługi znajdziesz tu Zwroty i transakcje - Developer Documentations - Confluence (atlassian.net)

W tej zakładce nie musisz nic wypełniać, możesz jedynie podejrzeć secret lub go zresetować.

Konfiguracja konta Merchanta - środowisko sandbox

Aby uzyskać dostęp do środowiska Sandbox uzupełnij i wyślij formularz kontaktowy korzystając z opcji Dla Biznesu i zakładki Sandbox.

Na potrzeby testów udostępniamy też Ci nasze aplikacje testowe InPost Mobile:

iOS instalujemy poprzez pobranie aplikacji z linku

https://testflight.apple.com/join/ey6Yherd

Android instalujemy poprzez pobranie z linku

https://appdistribution.firebase.dev/i/700485b0a22eeb95

Pamiętaj, aby przed rozpoczęciem testów upewnić się, że posiadasz najnowszą wersję aplikacji

Versions Compared

Old Version 32

New Version 33

Key

Autoryzacja

Pobranie tokenu

Przykład implementacji w języku PHP

Konfiguracja konta Merchanta - środowisko produkcyjne

Konfiguracja konta Merchanta - środowisko sandbox

Wymagania techniczne po stronie Merchanta