Použití OAuth 2.0 pro přístup k Identifikační službě GoPay
Identifikační služba GoPay využívá pro ověření přístupu autorizační službu metodou OAuth 2.0, konkrétně průchod Authorization Code.
Tip GoPay: Na webu naší dokumentace naleznete kompletní technickou specifikaci.
Pro úspěšné čtení identity Klienta přes Identifikační službu GoPay je nutné projít několik základních kroků:
- Získáte autorizační údaje GoPay
- Přesměrujete Klienta na Identifikační službu GoPay
- Klient udělí souhlas
- Přesměrování Klienta na návratovou URL Odběratele identity
Získaný klientský token umožňuje provádět operace přes Identifikační službu GoPay (např. číst identitu Klienta).
1) Autorizační služba
Prvním krokem je získání přístupových údajů k autorizační službě. Pokud chcete využívat funkcí Identifikační služby GoPay, postupujte prosím dle kroků uvedených v článku Popis identifikační služby.
Pokud již disponujete autorizačními údaji GoPay, je scénář získání klientského tokenu uveden v následujících krocích.
2) Přesměrování Klienta na autorizační službu
Odběratel identity přesměrovává Klienta na autorizační službu pro získání autorizačního kódu (code
). V rámci přesměrování se předávají potřebné GET
parametry.
Název parametru | Popis parametru | Povinný |
---|---|---|
scopes | perm.client.identification (oblast přístupu o kterou Odběratel identity žádá) | ANO |
client_id | Identifikátor aplikace Odběratele identity | ANO |
state | Párovací identifikátor (je zpětně vrácen jako GET parametr redirect_uri v dalším kroku) | NE |
redirect_uri | URL, na kterou bude Klient vrácen po udělení souhlasu Odběrateli identity | NE |
prefill_id | Výsledné ID funkce předvyplnění údajů | NE |
Výsledný link vypadá např. takto:
https://auth.gopay.com/consent?scopes[]=perm.client.identification:read&state=customer123&client_id=777777777777&redirect_uri=https%3A%2F%2Fcallback.odberatel-identity.cz&prefill_id=GhUhElzTqPmA5tUVJzO74SeMFt0Y3NEhpvQhbu5sTI8COWYqJFrdki
3) Přesměrování Klienta na URL Odběralete identity
redirect_uri
Odběratele identity s potřebným autorizačním kódem (code
) pro následné získání klientského tokenu.V případě, že došlo k neočekávanému zpracování, je vrácen parametr
error
s upřesněním konkrétní chyby.V redirectu mohou být předávány
GET
parametry:Název parametru | Popis parametru |
---|---|
code | Autorizační kód pro získání access tokenu, životnost 10 minut |
state | Párovací identifikátor |
error | Chyba v procesu |
Přesměrování vypadá např. následovně:
https://callback.odberatel-identity.cz/?code=98e804e5-f5ae-4c07-9e2e-539c06d623a2&state=customer123
4) Získání klientského tokenu
Na základě získaného autorizačního kódu (code
) Odběratel identity provede volání pro získání klientského access tokenu
.
Pro opětovné získání čerstvého access tokenu
je nutné použít postup obnovy klientského tokenu.
Název parametru | Popis parametru | Povinný |
---|---|---|
code | Dočasný autorizační kód | ANO |
client_id | client_credentials | ANO |
client_secret | client_credentials | ANO |
grant_type | Typ požadavku | ANO |
Se získaným tokenem (access token
) je možné provádět operace přes Identifikační službu. Seznam dostupných operací je uveden v naší dokumentaci.