Technical description
Access to the Services
NOD has two interfaces: A back-end system for PTOs as of today can be accessed through WebServices, and one client-oriented REST interface that can be accessed by NOD Clients over the internet. Both interfaces are also available in a TEST and QA environment.
NOD Back system
The baking system can only be reached via dedicated VPN tunnels which are set up against NOD's operating supplier by agreement with Entur. In addition, user names and passwords are required to reach the back office services. Use of NOD Backoffice is described in [Appendix A]. These services are defined in [HB V821.22 App D - Document provided on request.]. The following WebService services can be called:
AddOrders
GetOrderGroups
Update Order Group
GetOrderGroupTransactions
NOD Client interface
The NOD client interfaces are publicly available at HTTPS://nod.ioas.no/nod/services/client/. These services are defined in [HB V821.22 App B - Document provided on request.]. The PTO must ask Entur for a password for its NOD Clients to be able to call the services. The following REST services can be called:
| Method | URL | Return Values | Description |
|---|---|---|---|
| GET | / ecard / "mediaSerialNumberID" / groups / | URI list of | Returns a list of URIs to active order groups |
| - | - | - | - |
| POST | / ecard / "mediaSerialNumberID" / nodsession | The contents of the first command set of the first available group | The content of the first command set is returned by the NOD Client |
| - | - | - | - |
| POST | / group / "groupId" / node session | Contents of the first command set of the specified group Creates a NOD Session and reserves the specified group exclusively for the calling NOD Client. The content of the first command set is returned by the NOD Client | |
| - | - | - | - |
| GET | / group / "groupId" / nodsession / "nodsessionId" / cmdset / "cmdsetId" | list of node client commands that must be processed by the node client | Returns the largest list of NOD Client Commands that may be executed without the need for the server to process the results first |
| - | - | - | - |
| POST | / group / "groupId" / nodsession / "nodsessionId" / cmdset / "cmdsetId" | The URL of the next command set, as well as its contents. | Creates a new command set based on the result of the returned commands. |
Plugins
A Plugin is an independent WEB application that exposes a single REST interface to the NOD platform. See [HB V821.22 App C - Document provided on request.] for details. Here, developers are free to choose technology and platform themselves. NOD uses a Plugin by sending Image and the Order to its URL, in other words, a Plugin can be hosted outside the actual NOD platform, for example in an existing switch environment that the PTO has. This assumes that a secure communication channel is established between the NOD Platform and the Plugin. If a Plugin is to run on the NOD platform itself, it must be able to run on Apache Tomcat. If a Plugin deployes on the NOD Platform, it will also get the load balancing and failover properties that the NOD Platform offers.