Lokalisatie is bezig: Sommige inhoud wordt mogelijk nog in het Engels weergegeven terwijl we de vertaling afronden.

Integratiekwalificaties introductie

Prev Next

Dit is alleen beschikbaar voor accountmanagers met toegang tot accountinstellingen. Lees hier meer over toegangsrechten.

Beginnen

Om te beginnen met de Quinyx API zijn er een paar dingen die je moet weten.

Het framework dat wordt gebruikt voor autorisaties voor de REST API's is Oauth2. Meer gedetailleerde informatie is hier te vinden https://oauth.net/2/

Geloofsbrieven

De basisprocedure voor authenticatie is dat een gebruiker een set inloggegevens krijgt die worden geïdentificeerd met een uuid:

  • uuid - Dit is een identificatie voor de set inloggegevens. Deze is bedoeld om te communiceren met Quinyx-ondersteuning indien nodig.

  • Client-id - bewaar dit op een veilige plek. Kan gedeeld worden, meestal gebruikt als gebruikersnaam in applicaties zoals Postman of iets dergelijks.

  • Client secret - moet ZEER vertrouwelijk worden gehouden, dit is het wachtwoord en in combinatie met de Client-ID geeft het de eigenaar toegang tot de gedefinieerde scopes.

Scopes en rechten

Scopes

Scope bepaalt welke "groep" functionaliteit je via de API kunt bereiken.

Als voorbeeld

  • Voorspelling

  • Voorspelling van de voorspelling

  • Tags

  • Beschikbaarheid

  • Openingstijden

  • Groepen

  • Mapping

  • Afwezigheid

  • Statistieken

  • Samenwerkingsgroepen

  • AI-algoritmen

  • Mensen

  • Loonschema's

  • Overeenkomst

  • Werknemer

  • Diensten

Toestemmingen

Rechten bepalen wat je kunt doen met de functionaliteit waar je toegang toe hebt.

Lees - GET

Voeg toe - POST

Schrijven - PUT, PATCH

Verwijderen - VERWIJDEREN

Genereer referenties

  1. Klik op Accountinstellingen.

  2. Klik onder Toegangsrechten op Integratiegegevens. Als er inloggegevens bestaan, worden deze hier weergegeven en kun je namen en beschrijvingen van de bestaande bewerken. Je kunt ook zien welke scopes en machtigingen voor elke set inloggegevens zijn ingesteld.

  3. Om een nieuwe set inloggegevens aan te maken, klik je op Gegevens genereren.

    Naam

    (verplicht)

    Schrijf de naam van deze set referenties op. Dit kan later worden aangepast, maar het is een verplicht veld.

    Beschrijving

    (verplicht)

    Schrijf een beschrijving voor deze set referenties. Dit kan later worden aangepast, maar het is een verplicht veld.

    Versie

    Kies tussen de scopen van versie 2 en versie 3 .

    Scopes en Rechten

    Kies de scopes en machtigingen die je wilt dat de inloggegevens hebben

    Lees - HAAL, Voeg toe - POST, Schrijf - PLAATS, PATCH, Verwijder - VERWIJDER

  4. Wanneer je op Opslaan klikt, krijg je het Geheim te zien. Dit moet worden opgeslagen en afgehandeld omdat het zeer gevoelige informatie betreft. Je zult deze informatie niet meer kunnen zien.

  5. Sla het klantgeheim veilig op een locatie naar keuze en klik pas daarna op Klaar. Je zult je klantgeheim niet opnieuw kunnen weergeven. Je zult alleen de clientId en UUID van de inloggegevens kunnen zien.

Bewerkingsgegevens

Je kunt alleen de naam en beschrijving van de REST API-inloggegevens bewerken. Als je de scopes en/of rechten moet aanpassen, moet je nieuwe aanmaken en daarna de oude verwijderen.

Verwijder inloggegevens

Je kunt inloggegevens verwijderen, maar zorg ervoor dat ze niet in gebruik zijn voordat je dat doet.

Je hebt hier links naar de REST API-documentatie.