Ověřování
Restorm nemá rozbalovací seznam „typ ověřování“. Má něco obecnějšího: ověřovací požadavek, plnohodnotný požadavek, jehož úlohou je vytvářet hlavičky pro ostatní.
Výhoda: namodelovat lze jakékoli schéma, včetně těch, se kterými žádný rozbalovací seznam nepočítá — výměna ve dvou krocích, podepsaný token, domácí API. Nevýhoda: je nutné to jednou napsat.
Vytvoření ověřovací trasy
Section titled “Vytvoření ověřovací trasy”Klikněte pravým tlačítkem na složku proměnných ▸ Přidat ▸ Ověřovací požadavek.
Nejprve nastavte volání jako u kteréhokoli požadavku HTTP: metodu, URL, hlavičky, tělo. Potom otevřete jeho kartu Konfigurace, která nese tři nastavení vlastní ověřování.
Vytvořené hlavičky
Section titled “Vytvořené hlavičky”Seznam hlaviček, které tato trasa vloží do každého požadavku, jenž ji odkazuje. Každá hodnota je výraz vyhodnocený nad tělem odpovědi ověřovacího požadavku.
| Hlavička | Hodnota |
|---|---|
Authorization | {{token_type}} {{access_token}} |
Expirace (v sekundách)
Section titled “Expirace (v sekundách)”Výraz, rovněž vyhodnocený nad tělem odpovědi, který udává dobu platnosti
v sekundách — typicky {{expires_in}}. Když zůstane prázdný, token sám nikdy
nevyexpiruje.
Chybové kódy ověřování
Section titled “Chybové kódy ověřování”Stavové kódy HTTP, které — přijme-li je požadavek používající tuto trasu —
vyvolají obnovu tokenu a poté automatické opakování. Výchozí hodnoty:
401 a 403.
Dva pojmy, jedna věc
Section titled “Dva pojmy, jedna věc”Ověřovací požadavek je prvek, který vytvoříte ve stromu. Ověřovací trasa je tentýž prvek viděný z jiného požadavku, v přepínači, který ji připojuje. Oba pojmy označují tutéž entitu na dvou místech rozhraní.
Připojení trasy k požadavku
Section titled “Připojení trasy k požadavku”Na kartě požadavku, ve smartbaru, vypisuje přepínač Ověřovací trasa trasy dané složky proměnných. Výchozí popisek je Bez ověření.
Po připojení se vytvořené hlavičky vkládají při každém odeslání, token se
ukládá do mezipaměti až do své expirace a 401 vyvolá průhlednou obnovu.
Běžné recepty
Section titled “Běžné recepty”Bearer / OAuth 2 client credentials
Section titled “Bearer / OAuth 2 client credentials”Požadavek: POST https://auth.exemple.test/oauth/token, tělo
x-www-form-urlencoded s grant_type=client_credentials,
client_id={{clientId}}, client_secret={{clientSecret}}
(kde tajný klíč je hodnota typu Tajný klíč).
Vytvořená hlavička: Authorization = {{token_type}} {{access_token}}.
Expirace: {{expires_in}}.
Pokud přihlašovací údaje už máte, není potřeba žádný požadavek: prostě vložte hlavičku do požadavku (nebo do složky):
Authorization = Basic {{base64Encode (append (append user ":") password)}}
Klíč API
Section titled “Klíč API”Stačí hlavička nebo parametr dotazu:
X-API-Key = {{apiKey}}, kde klíč je proměnná typu Tajný klíč.
Token získaný dvěma voláními
Section titled “Token získaný dvěma voláními”Vytvořte scénář: první volání, extrakce
mezikódu, druhé volání a poté Nastavit proměnnou, která token vloží do
proměnných běhu. Následující požadavky scénáře ho přečtou pomocí {{jeton}}.
Co dělá import
Section titled “Co dělá import”Při importu specifikace se deklarovaná bezpečnostní schémata přeloží na předem zapojené hlavičky nebo parametry, přičemž se za vás vytvoří proměnná prostředí:
| Schéma ve specifikaci | Co Restorm vloží |
|---|---|
apiKey (hlavička nebo dotaz) | Pár pojmenovaný podle schématu, hodnota {{<schema>}} |
http / basic | Authorization: Basic {{<schema>_credentials}} |
http / bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Zbývá vám jen proměnnou vyplnit, nebo ji nahradit ověřovací trasou, pokud chcete automatickou obnovu.
Nativní přihlašovací údaje jednotlivých protokolů
Section titled “Nativní přihlašovací údaje jednotlivých protokolů”Některé protokoly hlavičkami HTTP neprocházejí. Jejich přihlašovací údaje jsou poli samotného požadavku:
| Protokol | Pole |
|---|---|
| MQTT | username, password, identifikátor klienta |
| AMQP | username, password, vhost |
| Redis | password |
| Kafka | Mechanismus SASL (plain, scram-sha-256, scram-sha-512), uživatelské jméno, heslo, TLS |
| STOMP | Hlavičky login a passcode rámce CONNECT |
| gRPC | Metadata volání |
Každé z těchto hesel přijímá hodnotu typu Tajný klíč.