Mittels der API stellt die Mitgliederverwaltung alle Funktionen der Interfaces Mitgliederverwaltung und Suche externen Sytemen zur Verfügung.

URL

Die URL unter der die API-Services ansprechbar sind ist abhängig von Ihrere Installation. Den Aufbau der Service-Url finden sie in den Systemeinstellungen.

Rechte

Das Rechtemanagement innerhalb von der API entspricht exakt dem Rechtemanagement der ICA-Anwendung. Benutzer, die auf das System über die Schnittstelle zugreifen wollen müssen einer Benutzergruppe zugeordnet sein, die den Zugriff auf die API erlaubt (Application - Global - API Access General). 

Administrationsempfehlung

Sofern eine Gruppierung externen Zugriff auf die Mitgliederverwaltung für "Nicht" menschliche Benutzer einrichten will wird folende Vorgehensweise empfohlen:

• Schritte Gruppierungsadministrator
  
  • Anlage eines neuen Mitglieds (Typ Nicht-Mitglied); Beispiel: Vorname System-X, Nachnahme: YYY 
  • Erzeugen eines Zugangs über die Funktionen für Mitglieder
  • Übermittlung der Mitgliedsnummer und id an den Systemverwalter
    
    
    
• Schritte Systemadministrator
  
  • In der Systemadministration (Personen) Suche einstellen auf Mitgliedsnummer, Mitglied suchen und auswählen
  • Über den Button "Groups" dem Benutzer zusätzlichen zu den zugewiesenen Gruppen die Gruppe "System API" zuweisen
    
    
• Schritte Gruppierungsadministrator
  
  • dem System-Mitglied analog zur Mitgliederverwaltung Tätigkeiten und insbesondere die benötigten Rechte zuweisen, damit den Zugriff des "System"-Mitgliedes wie gewünscht zu erhalten
  • aufgrund der Implementierung kann sich das System-Mitglied dann per Benutzer-Interface ebenso anmelden, wie die benötigten Operationen per API durchführen. Funktionen, die dem angemeldeten Benutzer NICHT zur Verfügung stehen sind über die API nicht verfügbar und umgekehrt. Die Überprüfung der Rechte erfolgt in jedem Fall auf der Ausführung der Operation und nicht notwendigerweise auf der Anzeige einer möglichen Operation