This article explains how to use the API's in the DevZone with EloView 4
Below describes how to use APIs in the Elo DevZone. This article covers the following:
1. Generate OAuth Credentials
2. Get Authentication token
3. Authorize APIs
4. Get OrgId:
5. Run API
1. Generate OAuth Credentials
OAuth (Open Authorization) is an open-standard authorization protocol that provides applications the ability for “secure designated access”. This will be used to get Authorization token.
a. Login to the EloView website: https://secure.eloview.com/
b. Click on the Profile Icon
c. Click on Generate OAuth credentials
d. Copy and paste the oAuth Credentials (clientID and clientSecret) to a notepad, then click OK
2. Get Authentication token
This is the process of authenticating users or processes for applications in the cloud. The user's application sends a request to the authentication service, which confirms the user's identity and issues a token. The user is then able to access the application.
a. Click on the API's tab
b. Expand the Authentication Grid and Click on the “Try it out” button (shown in the image below), it will enable you to enter values for the required parameters & show the execute button in bottom of the API box.
c. Add Client Id (path parameter) and clientsecret as body parameter (received from OAuth Credentials / Step 1) and then click on execute.
d. This will give the authentication token that can be used in further operations.
e. Check the response body & copy the access_token from response. This will be used as Bearer token for access to the other APIs. The response will look like the below image.
3. Authorize APIs
Access tokens are the thing that applications use to make API requests on behalf of a user. The access token represents the authorization of a specific application to access specific parts of a user's data.
a Click on the Authorize button placed at the top right corner of the screen.
b It will open a dialog from where we can add the value of the access token to authorize the APIs.
c. Type bearer & paste the access token in the input field.
d. Click on the Authorize button & close the pop-up
e. Now the user is authorized to access any available API.
4. Get OrgId:
OrgId (organization ID) will be used to perform different API actions from Dev-zone.
a. Click on the Gear icon
b. The OrgId is in the right bottom corner
5. Run API
Once authorization is done, we can run the APIs from dev-zone.
a. Expand the module tile e.g. Content / Get list of content
b. Click Try it out
c. Enter ORG ID
d. Select Execute
Results should look like this:
Please report any broken links by emailing support@elotouch.com and include a link to the knowledge article