Setup a kiosk feed to keep employees informed right at their workplace.
Manage API-keys
Please contact your CSM to enable kiosk API-keys for your tenant.
Video
Here's a short video that explains the basic concepts.
Walk-through
To setup a kiosk that shows news published in ahead, you need to first add an API-key for it. You can do this in the company settings under integrations.
The API-key is required for authentication when calling the kiosk feed API. Use multiple kiosk API-keys to support multiple kiosks showing different news.
When editors publish a news they can decide in which kiosk feeds their news should appear.
Private news cannot be shown in a kiosk feed.
The Kiosk-feed API
To receive the news for a certain kiosk do a GET-request to:
https://connect.aheadintranet.com/api/kioskfeed?code=MY_API_KEY&languageCode=LANG&size=SIZE
These are the query parameters to use:
| Parameter | Description | Required |
| code | The API key of the kiosk to receive the news for. | Yes |
| languageCode | The preferred language of the news. | Yes |
| size | The number of news to retrieve. The maximum is 12. | No, default is 1. |
The response looks as follows:
[
{
"title": "The title of the news",
"leadText": "The lead text of the news.",
"leadImageUrl": "https://url.of/lead-image?c=x98r",
"published": "2024-03-20T14:12:18Z",
"authorDetails": {
"name": "Arthur Author",
"jobTitle": "Writing Content",
"department": "Human Resources",
"officeLocation": "PostParc",
"city": "Bern",
"companyName": "MountainGear"
},
"channels": ["HR-Infos"],
"url": "https://app.aheadintranet.com/news/4a308770-5210-4455-8f52-13616b7c2c91"
}
]
The details about the returned properties:
| Property | Description | Can be null |
| title | The title of the news. Max 100 characters. | No |
| leadText | The first 300 characters of the content of the news. | Yes |
| leadImageUrl | The url of the first image of the news. This is either an external url or it is a url to an image stored in ahead storage. In the latter case the url is valid for only 30 minutes. | Yes |
| published | The date of when the news was published for the first time | No |
| authorDetails.name | The name of the author of the news, as shown in ahead. | No |
| authorDetails.jobTitle | The author's value of the Entra ID property 'jobTitle' | Yes |
| authorDetails.department | The author's value of the Entra ID property 'department' | Yes |
| authorDetails.officeLocation | The author's value of the Entra ID property 'officeLocation' | Yes |
| authorDetails.city | The author's value of the Entra ID property 'city' | Yes |
| authorDetails.companyName | The author's value of the Entra ID property 'companyName' | Yes |
| channels | The name of the channels the news is published in. | No, but can be empty |
|
url |
The url of the news. |
No |
The response is cached for 15 minutes per API-key and size.
Migration
If you are using the old kiosk API that uses Entra ID accounts for authentication you need to migrate to this version. To do so, proceed as follows:
- For every Entra ID account you are using to call the old kiosk API create a kiosk API-key.
- Inform your editors that they should start selecting the relevant kiosks when publishing news. If needed, they should re-publish older news that are still relevant and assign kiosks.
- Your custom digital signage implementation needs to be adjusted to the new API. The main difference is the authentication. Use the respective API keys created instead of the previously used accounts.