Requirements
The Restfull API is an additional module of James (JAPI) and must be licensed separately.
General structure
"Representational State Transfer", REST for short, is a modern programming paradigm for web services that is alternative to SOAP or RPC. ( see also: https://en.wikipedia.org/wiki/Representational_state_transfer ) metaSEC James offers the REST API service for programmes that do not communicate via the regular portal or WebApp. An example is the metaSEC James Outlook plugin, which also communicates with the James server via the REST interface. The REST API is the preferred way to implement any kind of integration with the James middleware. The required data is retrieved or provided specifically via REST resources. The retrieval works via URL parameters defined by the system. The return value is formatted in JSON format and can be processed directly by most current programming languages.
Configuration
To configure the functionality of the RESTAPI, log in to the James Portal as an administrative user. Then switch to the "System Manager". Under the menu item "Plugins" you should find the item "RESTAPI". If it is not visible, this function is not activated on your system. In this case, please contact your JAMES Solution Partner or Integrator.
In principle, an unlimited number of portals can be created for different purposes. For regular operation, a single portal is sufficient. You create a new portal by clicking on "Add RESTAPI Portal". This will take you to the configuration screen for creating new RESTAPI portals and endpoints.