Introduction
The Push API enables sending of a push message to a web application via a push service. It gives the ability to receive events pushed to them from a server. An application server can send a push message at any time, even when a web application or user agent is inactive. The push service ensures reliable and efficient delivery to the user agent.
Events from GP10 will be pushed to API clients through SignalR, which is an open source technology (lead by Microsoft) and has clients in all major platforms and technology. More information about SignalR can be found here.
How it works
1. Check if your API centre files are updated according to the latest GP10 release, or else import them via Postman.
For example, GP10 version 1.75.03 should have the following API centre files from 28/04/2021:
- “API Center.postman_collection_28_4_21.json”
- “dotnet runner.postman_environment_28_4_21.json”
The updated API centre files are available here.
2. Go to "Setup" > "Options" > "General" > "Communication" > "Settings" and make sure that “Pass events to API” option is set to "YES".
3. Find attached the related files for pushing events on “ACS.Server.API.Client.IO.Net” folder.
The developer needs to build a project based on those files.
Live Demo
Download and run the GP10 Push-Events - API Demo.exe to show an example of live events shown from our on-site server.
Technical Demo
- Unzip the attached folder “Debug - PUSH API DEMO”.
- Run "ACS.Server.API.Client.IO.Console.Net.exe”.
- A command window is displayed
- d. swipe a card and the card event is displayed.
Comments
0 comments
Please sign in to leave a comment.