API-Widgets

Created by Jens Leijon, Modified on Tue, 08 Nov 2022 at 06:55 AM by Jens Leijon

PORTAL

The first thing you need to do to use the API-Widget is to create credentials so that your other systems can connect to the API and send in information.

This is done in under the Apps title in Connectel Portal.


So first we click portal on the  landing page


Then we go to "Apps" in the left menu.


And then you press Add App to add new credentials


You will see this information on the left where you can choose the owner of the new "App"

It's crucial that you note down the Secret as this will not be shown again and can't be recovered if you loose it.


Then you just press Save and your new credentials will be live and ready for use.


SKYVIEW/INSIGHTS


To show information and statistics from other systems inside Insights and Skyview you use the API-widget.


To set up an API-widget in Insights or Skyview you need to press the Add Widgets button


Insights



Skyview


Then you give the widget a name, and also a Type. The type have to be Table or Text if you are using the API-widget and then you turn on the API-widget switch so that it's green and then press save.



Now we will see this edit menu for the API-widget where we can customize the metrics and add new metrics. 

Note that there is only 2 "metrics" that you can choose, "Custome Number" and "Customer String"


Custom Number is used to display numbers

Custom String is used to display text


When you have added either Number or String you can edit that widget and give it your own name if you want to by pressing the pen icon on the metric.



The information shown in the white box is information you have to give to the people responsible for sending data to the widget.


This tells them how to send data in to this widget, they will also need the client ID and Secret from the first step in this article.

There is also some API-documentation on this link SwaggerHub - API Widget Documentation about how to authenticate against the API and how it works that they will need.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article