Introduktion till integreringsautentiseringsuppgifter
Uppdaterad
av
Victor Jespersen
Komma igång
För att komma igång med Quinyx REST API finns det några saker du behöver veta.
Ramverket som används för auktoriseringar till REST API:erna är OAuth2. Mer detaljerad information finns här https://oauth.net/2/
Autentiseringsuppgifter
Det grundläggande flödet för autentisering är att en användare får en uppsättning autentiseringsuppgifter som identifieras med ett UUID:
- UUID - detta är en identifierare för uppsättningen av autentiseringsuppgifter. Detta ska användas vid kommunikation med Quinyx support om det behövs.
- Client ID - håll detta på en säker plats. Kan delas, används vanligtvis som användarnamn i applikationer som Postman eller liknande.
- Client secret - måste hållas MYCKET konfidentiellt. Detta är lösenordet och i kombination med Client ID ger det ägaren åtkomst till de definierade scopena.
Scopes och behörigheter
Scopes | Scope bestämmer vilken "grupp" av funktionalitet du kommer att kunna komma åt via API:et. Version 2 autentiseringsuppgifter:
Version 3 autentiseringsuppgifter:
|
Behörigheter  | Behörigheter avgör vad du kan göra med funktionaliteten som du har åtkomst till. Läs - GET Lägg till - POST Skriv - PUT, PATCH Ta bort - DELETE |
Generera autentiseringsuppgifter
- Klicka på Kontoinställningar.
- Under åtkomsträttigheter, klicka på Integreringsautentiseringsuppgifter. Om autentiseringsuppgifter finns visas de här och du kan redigera namn och beskrivningar för de befintliga. Du kan också se vilka omfattningar och behörigheter som är inställda för varje uppsättning autentiseringsuppgifter.
- För att skapa en ny uppsättning autentiseringsuppgifter, klicka på Generera autentiseringsuppgifter.
Namn (obligatoriskt) | Skriv namnet på denna uppsättning autentiseringsuppgifter. Detta kan redigeras senare, men det är ett obligatoriskt fält. |
Beskrivning (obligatoriskt) | Skriv en beskrivning av denna uppsättning autentiseringsuppgifter. Detta kan redigeras senare, men det är ett obligatoriskt fält. |
Version | Välj mellan Version 2 och Version 3 scopes. |
Omfång och behörigheter | Välj de omfång och behörigheter som du vill att autentiseringsuppgifterna ska ha Läs - GET, Lägg till - POST, Skriv - PUT, PATCH, Ta bort - DELETE |
- När du klickar på Spara, visas Secret för dig. Detta bör lagras och hanteras på ett lämpligt sätt med tanke på att det är mycket känslig information. Du kommer inte att kunna se denna information igen.
- Lagra clientSecret säkert på en plats som du väljer och klicka sedan på Klar. Du kommer inte att kunna se din clientSecret igen. Du kommer endast att kunna se clientId och UUID för autentiseringsuppgifterna.
Redigera autentiseringsuppgifter
Du kan endast redigera namn och beskrivning för REST API-autentiseringsuppgifterna. Om du behöver redigera scopes och/eller behörigheter måste du skapa nya och sedan ta bort de gamla.
