Voraussetzungen
Die Restfull API ist ein zusätzliches Modul von James (JAPI) und muss gesondert lizenziert werden.
Genereller Aufbau
„Representational State Transfer“, kurz REST, ist ein modernes, zu SOAP oder RPC alternatives Programmierparadigma für Web-Services. ( siehe auch: https://de.wikipedia.org/wiki/Representational_State_Transfer ) metaSEC James bietet den REST API Service für Programme an, welche nicht über das reguläre Portal oder WebApp kommunizieren. Als Beispiel ist hier das metaSEC James Outlook Plugin genannt, welche ebenfalls über das REST Interface mit dem James Server kommuniziert. Die REST API ist der bevorzugte Weg um mit der James Middelware jegliche Art der Integration umzusetzen. Die benötigten Daten werden REST spezifisch über s.g. Ressourcen abgerufen rsp. bereitgestellt. Der Abruf funktioniert über entsprechend vom System festgelegte URL Parameter. Der Rückgabewert ist im JSON Format formatiert und kann von den meisten aktuellen Programmiersprachen direkt weiterverarbeitet werden.
Konfiguration
Um die Funktionalität der RESTAPI zu konfigurieren, loggen Sie sich als administrativer Benutzer im James Portal ein. Danach wechseln Sie in den „System Manager“. Unter dem Menüpunkt „Plugins“ sollte der Punkt „RESTAPI“ zu finden sein. Sollte dieser nicht sichtbar sein, ist diese Funktion auf Ihrem System nicht freigeschaltet. In dem Falle kontaktieren Sie bitte Ihrem JAMES Solution Partner oder Integrator.
Grundsätzlich können unbegrenzt viele Portale für jeweils unterschiedliche Zwecke angelegt werden. Für den regulären Betrieb genügt ein einzelnes. Ein neues Portal erzeugen Sie, indem Sie auf „RESTAPI Portal hinzufügen“ klicken. Damit gelangen Sie in die Konfigurationsmaske für die Anlage von neuen RESTAPI Portalen und Endpunkten.