12. API / Schnittstellen

1 Welche Möglichkeiten habe ich um auf das Backend zuzugreifen?
2 Woher bekomme ich eine Beschreibung der API Endpunkte?
3 Wie kann ich auf GraphQL zugreifen?
4 Wie kann ich mit einer Browseranwendung am besten MAPI nutzen?

Welche Möglichkeiten habe ich um auf das Backend zuzugreifen?

Grundsätzlich bieten wir mehrere Möglichkeiten an:

REST-API, GraphQL, Signal-R

Woher bekomme ich eine Beschreibung der API Endpunkte?

antony Cloud Office bietet für die REST-API Endpunkte verschiedene Swagger.json-Dateien an, welche direkt in der jeweiligen Installation verfügbar sind:

Integration-Dienst: /integration/swagger/v1/swagger.json
Funktion: Übergreifende Funktionen, Wiedervorlage, Teilen, Konfiguration, CustomFields, Benutzergruppen, Verknüpfungen, Module, ObjectSets, PermissionGroups, Register, Suche, Stellvertreter, Ampel, Benutzer

Kontakt-Dienst: /contact/swagger/v1/swagger.json
Funktion: Kontaktverwaltung, Kontaktfelder, Kontaktgruppen, Kontakte

Flexobjekt-Dienst: /flexobject/swagger/v1/swagger.json
Funktion: Flexobjektverwaltung, Flexobjekte, Flexobjekttypen, Flexobjektfelder

Chat-Dienst: /chat/swagger/v1/swagger.json
Funktion: Chats, Chatanhänge, Chats, Chatnachrichten, Chat-Benutzer

E-Mail-Dienst: /mail/swagger/v1/swagger.json
Funktion: E-Mail-Verwaltung, Entwürfe, E-Mail-Anhänge, Postfächer, Mailkonfiguration, Mails, Signaturen

Kalender-Dienst: /calendar/swagger/v1/swagger.json
Funktion: Kalenderverwaltung, Termine, CalDav Synchronisation, Kalender, Termin-Einladungen

Videochat-Dienst: /videochat/swagger/v1/swagger.json
Funktion: Videochatverwaltung, Videochats

Wie kann ich auf GraphQL zugreifen?

Eine GraphiQL Oberfläche steht direkt in der Installation unter /ui/graphiql zur Verfügung.
Um diese nutzen zu können muss jedoch vorher ein Bearer-Token in den Header eingefügt werden.

graphiQL Konfiguration

Dazu einfach den Header im JSON-Format wie im Screenshot zu sehen eingeben und den Token, z.B. vom Administrator dort einfügen.
Anschließend auf “refresh” (1) klicken.

Wie kann ich mit einer Browseranwendung am besten MAPI nutzen?

Wir empfehlen als Best-Practise die Benutzung von Thunderbird um auf Windows Clients die MAPI Funktionalität zu nutzen.

Folgendes Vorgehen:

Einrichtung eines Postfaches in antonyNG
Konfiguration einer Relay Benutzername/Passwort-Kombination (Relay Konfiguration)
Prüfen ob die Anwendung welche MAPI nutzt soll 32bit oder 64bit ist
Download der entsprechenden Thunderbird Version (32bit / 64bit)
Installation von Thunderbird und Einrichtung eines POP3 Postfachs mit beliebigen Server- und Benutzerdaten
Einrichtung des SMTP Ausgangsservers in Thunderbird (Benutzername & Passwort wie in der Relay Konfiguration beschrieben)
In der Startseite der Thunderbird-Einstellungen gibt es die Möglichkeit zu prüfen ob Thunderbird “Standardanwendung” ist. Diese drücken und Thunderbird zu Standardanwendung für E-Mail machen