Introductie integratiereferenties
Updated
by
Victor Jespersen
Aan de slag
Om aan de slag te gaan met Quinyx REST API, zijn er enkele dingen die u moet weten.
Het framework dat wordt gebruikt voor autorisaties van de REST API's is OAuth2. Meer gedetailleerde informatie is hier te vinden https://oauth.net/2/
Inloggegevens
De basisstroom voor authenticatie is dat een gebruiker een set inloggegevens krijgt die wordt geïdentificeerd met een UUID:
- uuid - dit is een identificatie voor de set inloggegevens. Dit moet worden gebruikt in communicatie met Quinyx-ondersteuning indien nodig.
- Client ID - bewaar dit op een veilige plaats. Kan worden gedeeld, meestal gebruikt als gebruikersnaam in toepassingen zoals Postman of vergelijkbare.
- Client secret - moet ZEER vertrouwelijk worden bewaard, dit is het wachtwoord en in combinatie met de Client ID geeft het de eigenaar toegang tot de gedefinieerde scopes.
Scopes en machtigingen
Scopes | Scope bepaalt welke "groep" functionaliteit u via de API kunt benaderen. Versie 2-inloggegevens:
Versie 3 credentials:
|
Machtigingen  | Machtigingen bepalen wat u kunt doen met de functionaliteit waartoe u toegang hebt. Lezen - GET Toevoegen - POST Schrijven - PUT, PATCH Verwijderen - DELETE |
Credentials genereren
- Klik op Accountinstellingen.
- Onder Toegangsrechten klikt u op Integratiereferenties. Als referenties bestaan, worden deze hier weergegeven en kunt u namen en beschrijvingen van de bestaande referenties bewerken. U kunt ook zien welke scopes en machtigingen voor elke set referenties zijn ingesteld.
- Om een nieuwe set referenties te maken, klikt u op Credentials genereren.
Naam (verplicht) | Voer de naam van deze set referenties in. Dit kan later worden bewerkt, maar het is een verplicht veld. |
Beschrijving (verplicht) | Voer een beschrijving voor deze set referenties in. Dit kan later worden bewerkt, maar het is een verplicht veld. |
Versie | Kies tussen Versie 2 en Versie 3 bereiken. |
Bereiken en machtigingen | Kies de bereiken en machtigingen die u aan de inloggegevens wilt toekennen Lezen - GET , Toevoegen - POST, Schrijven - PUT, PATCH, Verwijderen - DELETE |
- Wanneer u op Opslaan, klikt, wordt u het Secret gepresenteerd. Dit moet op passende wijze worden opgeslagen en behandeld, aangezien het zeer gevoelige informatie betreft. U kunt deze informatie niet opnieuw bekijken.
- Sla het clientgeheim veilig op op een locatie naar keuze en klik vervolgens op Gereed. U kunt uw clientgeheim niet opnieuw weergeven. U kunt alleen de clientId en UUID van de inloggegevens bekijken.
Inloggegevens bewerken
U kunt alleen de naam en beschrijving van de REST API-inloggegevens bewerken. Als u de bereiken en/of machtigingen wilt bewerken, moet u nieuwe inloggegevens maken en vervolgens de oude verwijderen.
