Dit artikel legt uit hoe je de API's in de DevZone met EloView 4 kunt gebruiken
Hieronder wordt beschreven hoe je API's in de Elo DevZone kunt gebruiken. Dit artikel behandelt het volgende:
1. OAuth-gegevens genereren
2. Authenticatietoken krijgen
3. API's autoriseren
4. OrgId krijgen:
5. API uitvoeren
1. OAuth-gegevens genereren
OAuth (Open Authorization) is een open standaard autorisatieprotocol dat applicaties in staat stelt tot “veilige aangewezen toegang”. Dit zal worden gebruikt om een authenticatietoken te verkrijgen.
a. Meld je aan op de EloView-website: https://secure.eloview.com/
b. Klik op het Profielpictogram
c. Klik op OAuth-gegevens genereren
d. Kopieer en plak de OAuth-gegevens (clientID en clientSecret) in een notepad, en klik op OK
2. Authenticatietoken krijgen
Dit is het proces voor het authenticeren van gebruikers of processen voor applicaties in de cloud. De applicatie van de gebruiker stuurt een verzoek naar de authenticatieservice, die de identiteit van de gebruiker bevestigt en een token uitgeeft. De gebruiker kan vervolgens toegang krijgen tot de applicatie.
a. Klik op het API's-tabblad
b. Breid het Authenticatie Grid uit en Klik op de “Probeer het uit”-knop (zoals weergegeven in de afbeelding hieronder), dit stelt je in staat waarden voor de vereiste parameters in te voeren & toont de uitvoerknoop onderaan het API-vak.
c. Voeg Client Id (padparameter) en clientsecret toe als lichaamsparameter (ontvangen van OAuth-gegevens / Stap 1) en klik vervolgens op uitvoeren.
d. Dit zal het authenticatietoken geven dat kan worden gebruikt voor verdere bewerkingen.
e. Controleer de responsebody & kopieer de access_token uit de response. Dit zal worden gebruikt als Bearer-token voor toegang tot de andere API's. De response zal eruitzien als de onderstaande afbeelding.
3. API's autoriseren
Toegangstokens zijn wat applicaties gebruiken om API-verzoeken te doen namens een gebruiker. Het toegangstoken vertegenwoordigt de autorisatie van een specifieke applicatie om toegang te krijgen tot specifieke delen van de gegevens van een gebruiker.
a. Klik op de Authorize-knop in de rechter bovenhoek van het scherm.
b. Dit opent een dialoog waar we de waarde van het toegangstoken kunnen toevoegen om de API's te autoriseren.
c. Typ bearer & plak het toegangstoken in het invoerveld.
d. Klik op de Authorize-knop & sluit de pop-up
e. Nu is de gebruiker geautoriseerd om toegang te krijgen tot elke beschikbare API.
4. OrgId krijgen:
OrgId (organisatie-ID) zal worden gebruikt om verschillende API-acties uit te voeren vanuit de Dev-zone.
a. Klik op het Instellingenpictogram
b. De OrgId bevindt zich in de rechterbenedenhoek
5. API uitvoeren
Zodra de autorisatie is voltooid, kunnen we de API's vanuit de Dev-zone uitvoeren.
a. Breid de module tegel uit, bijv. Inhoud / Lijst van inhoud ophalen
b. Klik op Probeer het uit
c. Voer de ORG ID in
d. Selecteer Uitvoeren
Resultaten zouden er als volgt uit moeten zien:
Please report any broken links by emailing support@elotouch.com and include a link to the knowledge article