Authenticatie
Restorm heeft geen keuzelijst “authenticatietype”. Het heeft iets algemeners: het authenticatieverzoek, een volwaardig verzoek dat als taak heeft headers voor andere verzoeken te produceren.
Het voordeel: elk schema is te modelleren, ook de schema’s waar geen enkele keuzelijst in voorziet — een uitwisseling in twee stappen, een ondertekend token, een eigen API. Het nadeel: u moet het één keer uitschrijven.
Een authenticatieroute maken
Section titled “Een authenticatieroute maken”Rechtsklik op een omgevingsmap ▸ Toevoegen ▸ HTTP-authenticatieverzoek.
Configureer de aanroep eerst zoals elk ander HTTP-verzoek: methode, URL, headers, body. Open daarna het tabblad Configuratie, waar de drie instellingen staan die specifiek voor authenticatie zijn.
Geproduceerde headers
Section titled “Geproduceerde headers”De lijst met headers die deze route zal injecteren in elk verzoek dat ernaar verwijst. Elke waarde is een expressie die wordt geëvalueerd op de body van de respons van het authenticatieverzoek.
| Header | Waarde |
|---|---|
Authorization | {{token_type}} {{access_token}} |
Verloop (seconden)
Section titled “Verloop (seconden)”Een expressie, ook geëvalueerd op de body van de respons, die de geldigheidsduur
in seconden geeft — doorgaans {{expires_in}}. Laat u die leeg, dan verloopt het
token nooit vanzelf.
Authenticatiefoutcodes
Section titled “Authenticatiefoutcodes”De HTTP-statussen die, wanneer een verzoek dat deze route gebruikt ze ontvangt,
leiden tot een vernieuwing van het token en daarna een automatische nieuwe
poging. Standaard: 401 en 403.
Twee termen, één ding
Section titled “Twee termen, één ding”Een authenticatieverzoek is het element dat u in de boom aanmaakt. Een authenticatieroute is datzelfde element, gezien vanuit een ander verzoek, in de kiezer die het eraan koppelt. Beide termen verwijzen naar dezelfde entiteit, op twee plekken in de interface.
Een route aan een verzoek koppelen
Section titled “Een route aan een verzoek koppelen”Op het tabblad van het verzoek staat in de smartbar een kiezer Authenticatieroute met de routes van de omgevingsmap. Het standaardlabel is Geen authenticatie.
Zodra de route is gekoppeld, worden de geproduceerde headers bij elke verzending
geïnjecteerd, wordt het token gecachet tot het verloopt, en leidt een 401 tot
een vernieuwing die u niet merkt.
Veelgebruikte recepten
Section titled “Veelgebruikte recepten”Bearer / OAuth 2 client credentials
Section titled “Bearer / OAuth 2 client credentials”Verzoek: POST https://auth.exemple.test/oauth/token, body
x-www-form-urlencoded met grant_type=client_credentials,
client_id={{clientId}}, client_secret={{clientSecret}}
(waarbij het geheim een waarde van het type Geheim
is).
Geproduceerde header: Authorization = {{token_type}} {{access_token}}.
Verloop: {{expires_in}}.
Er is geen verzoek nodig als u de inloggegevens al hebt: zet de header simpelweg op het verzoek (of op de map):
Authorization = Basic {{base64Encode (append (append user ":") password)}}
API-sleutel
Section titled “API-sleutel”Een header of een queryparameter is genoeg:
X-API-Key = {{apiKey}}, waarbij de sleutel een variabele van het type Geheim
is.
Token dat u in twee aanroepen ophaalt
Section titled “Token dat u in twee aanroepen ophaalt”Maak een scenario: eerste aanroep, de
tussencode eruit halen, tweede aanroep, en daarna Variabele instellen om het
token in de runvariabelen te zetten. De volgende verzoeken van het scenario lezen
het met {{jeton}}.
Wat de import doet
Section titled “Wat de import doet”Bij de import van een specificatie worden de gedeclareerde beveiligingsschema’s omgezet in voorgeschakelde headers of parameters, met een omgevingsvariabele die voor u wordt aangemaakt:
| Schema in de specificatie | Wat Restorm neerzet |
|---|---|
apiKey (header of query) | Een paar dat naar het schema is genoemd, met waarde {{<schema>}} |
http / basic | Authorization: Basic {{<schema>_credentials}} |
http / bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
U hoeft alleen nog de variabele in te vullen, of haar te vervangen door een authenticatieroute als u de automatische vernieuwing wilt.
Native inloggegevens per protocol
Section titled “Native inloggegevens per protocol”Sommige protocollen werken niet met HTTP-headers. Hun inloggegevens zijn velden van het verzoek zelf:
| Protocol | Velden |
|---|---|
| MQTT | username, password, client-ID |
| AMQP | username, password, vhost |
| Redis | password |
| Kafka | SASL-mechanisme (plain, scram-sha-256, scram-sha-512), gebruikersnaam, wachtwoord, TLS |
| STOMP | De headers login en passcode van de CONNECT |
| gRPC | Metadata van de aanroep |
Elk van deze wachtwoorden accepteert een waarde van het type Geheim.