Je kunt de OAuth-implementatie van Studio verbinden via Postman, een applicatie die API-ontwikkeling vereenvoudigt. Voordat je met de stappen in dit artikel begint, controleer of je toegang hebt tot Postman in een webbrowser of dat je Postman hebt gedownload en geïnstalleerd, en of je toegang hebt tot een Studio-account waarmee je een OAuth-client-ID en -geheim kunt genereren. Zie de StudioPublic API-documentatie voor meer informatie over de Studio API.
Opmerking: Integraties die de omleidings-URI urn:ietf:wg:oauth:2.0:oob in de OAuth-flow gebruiken, moeten deze expliciet toevoegen aan de lijst met omleidings-URI's op de ontwikkelaarssleutel.
Open Postbode
Klik in Postman op het pictogram Collecties [1].
Klik op het plusteken [2] en klik vervolgens op de optie Lege verzameling [3].
Collectie maken
Geef de verzameling een naam.
Open het tabblad Autorisatie
Klik in de verzameling op het tabblad Autorisatie [1].
Klik op het vervolgkeuzemenu Auth Type [2] en selecteer de optie OAuth 2.0 [3].
Scrol naar het gedeelte 'Nieuw token configureren' en voer een naam in voor het token.
Opmerking: Als u de Postman-desktopapp gebruikt, moet u mogelijk het selectievakje 'Autoriseren via browser' aanvinken.
Open Canvas
Om de Auth-URL en de Access Token-URL te vinden, opent u Canvas in een nieuw browservenster. Klik in Canvas op de link Admin [1] en vervolgens op de naam van uw account [2].
Open het tabblad Apps
Klik in de accountnavigatie op de link Instellingen [1] en vervolgens op het tabblad Apps [2].
Klik op de knop 'App-configuraties bekijken' [3].
Zoek de Studio-app
Zoek Studio in de lijst met externe apps. Klik vervolgens op de knop Instellingen [1] en selecteer de optie Bewerken [2].
App-configuratiegegevens bekijken
Kopieer in het venster 'App bewerken' de start-URL tot aan, maar exclusief, de eerste schuine streep na de hostnaam.
URL's toevoegen in Postman
Plak in Postman de Studio Launch URL in zowel het veld Auth URL als het veld Access Token URL.
Voeg aan het einde van het veld Auth URL [1] /api/public/oauth/authorize toe aan de URL.
Om het veld Access Token URL [2] af te sluiten, voegt u /api/public/oauth/token toe aan de URL.
Kopieer de callback-URL
Om een ontwikkelaarsleutel in Studio aan te maken, heb je de callback-URL van Postman nodig. Kopieer de callback-URL.
Open Studio
Open Studio, via uw zelfstandige Studio-instantie of via Canvas.
Klik in Studio op de link Instellingen [1] en vervolgens op het tabblad Ontwikkelaarssleutels [2]. Om een nieuwe ontwikkelaarssleutel toe te voegen, klikt u op de knop Ontwikkelaarssleutel toevoegen [3].
Maak een Studio-ontwikkelaarssleutel aan
Voer in het venster Sleutelinstellingen een naam voor de sleutel in het veld Naam in [1].
Plak in het veld Redirect URIs [2] de Callback URL die je uit Postman hebt gekopieerd.
Zodra u de sleutelgegevens hebt voltooid, klikt u op de knop Sleutel opslaan [3].
Opmerking: Integraties die de omleidings-URI urn:ietf:wg:oauth:2.0:oob in de OAuth-flow gebruiken, moeten deze expliciet toevoegen aan de lijst met omleidings-URI's op de ontwikkelaarssleutel.
Kopieer de klant-ID en het geheime sleutelnummer.
De nieuwe ontwikkelaarssleutel wordt weergegeven in Studio. Kopieer de Client-ID [1]. Om het geheim weer te geven, klikt u op de knop Weergeven [2] en kopieert u vervolgens het geheim [2].
Een nieuw toegangstoken verkrijgen
Plak in Postman de Client ID en Client Secret uit Studio in de bijbehorende velden [1]. De overige velden zijn optioneel.
Nadat u alle tokengegevens hebt ingevoerd, klikt u op de knop 'Nieuw toegangstoken verkrijgen' [2].
Log in bij Studio
Er verschijnt een pop-upvenster of een nieuw tabblad waarin u wordt gevraagd in te loggen bij Studio. U kunt inloggen met de inloggegevens van uw zelfstandige Studio-account [1] of met uw Canvas-inloggegevens [2].
Autoriseer de postbode
Studio zal u vragen om toegang tot Postman te verlenen. Klik in het Studio-venster op de knop 'Autoriseren '.
Bekijk de vervaldatum van het token
Nadat je de autorisatie voor het token hebt bevestigd, toont Postman de tokengegevens. Tokens zijn beperkt beschikbaar. In het gedeelte 'Huidig token' worden de vervaldatum en -tijd van het token weergegeven.
