Hyperlinks aus WOWIPORT zu externen Anwendungen integrieren

Die externen Sprungpunkte können sowohl statisch, unter Verwendung von "Id" und "IdNum", als auch variabel unter Verwendung einer API angelegt werden.

Anlage einer statischen URL

Erforderliche Benutzerrechte

Für die Anlage und Verwaltung von externen Sprungpunkten benötigt der Benutzer die Berechtigungen "Externe Sprungpunkte" und "Gruppe - Externe Anwendungen" aus dem Bereich "Administration". Zudem kann es notwendig sein, die Rechte für die Erstellung von Webhooks zu vergeben, da diese in derselben Maske bearbeitet werden.

Anlage eines Sprungpunktes

Statische Sprungpunkte können auf Gruppenebene angelegt werden. Die Einstellung erfolgt in der "Benutzerverwaltung" unter "Gruppen".

In der gewünschten Gruppe kann der Sprungpunkt im Tab "Externe Anwendungen" erfasst werden.

Der Name des Sprungpunktes wird später in der Kopfzeile der gewählten Entität angezeigt. Als Platzhalter können "#Id#" und "#IdNum#" verwendet werden. Bitte beachten Sie, dass die Platzhalter case sensitive sind und dass die "IdNum" mit den vom Kunden definierten Sonderzeichen übermittelt wird. Dies kann in Einzelfällen zu Komplikationen führen.

Derzeit stellen wir die Funktion für folgende Entitäten bereit:

• Auftrag

• Darlehen

• Fremdverwaltungsvertrag

• Gebäude

• Grundstück

• Mitgliedschaft

• Nutzungsvertrag

• Nutzungseinheit

• Person

• Wirtschaftseinheit

• Kreditoren

Wurde der Sprungpunkt gespeichert, kann dieser von allen Nutzern unter der Gruppe im Infobereich jener Objekte aufgerufen werden, für deren Entität der Sprungpunkt angelegt wurde.

Anlage von externen Sprungpunkten per API

Einrichtung der Sprungpunktkonfiguration

Im API-Key können im Tab "Web Hook und Sprungpunkte" neue externe Sprungpunktkonfigurationen hinzugefügt werden.

Wird eine neue Konfiguration angelegt, muss ein Name vergeben werden, welcher dann in der Entität angezeigt wird. Hinter diesem Namen liegt der individuelle Link in die Partneranwendung. Zudem muss der Systemzweck und die Entität angegeben werden. Der Systemzweck wird üblicherweise "Echt" oder "Test" lauten. Die Entität bestimmt, in welchem Bereich von WOWIPORT der Sprungpunkt angezeigt werden kann.

Derzeit stellen wir die Funktion für folgende Entitäten bereit:

• Auftrag

• Darlehen

• Fremdverwaltungsvertrag

• Gebäude

• Grundstück

• Mitgliedschaft

• Nutzungsvertrag

• Nutzungseinheit

• Person

• Wirtschaftseinheit

Bereits angelegte Sprungpunkte werden unterhalb der Einstellungen in einer Tabelle angezeigt, können jedoch nicht bearbeitet werden.

Externe Sprungpunkte Konfiguration abfragen

Dies sind die Konfigurationen, für welche externe Links von Ihrem User aus angelegt werden können.

Version 1.2

GET /openwowi/v1.2/ExternalLink/ExternalLink HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "SystemPurpose": "text",
    "ExternalLinkEntity": {
      "Id": 1,
      "Code": "text",
      "EntityName": "text"
    }
  }
]

Externe Sprungpunkte abfragen

Dies sind die tatsächlich mit den Objekten der Entität verbundenen Links in die Partneranwendung.

Version 1.2

GET /openwowi/v1.2/ExternalLink/EntityLink HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "Url": "text",
    "EntityId": 1,
    "Configuration": {
      "Id": 1,
      "Name": "text",
      "EntityName": "text"
    }
  }
]

Externe Sprungpunkte anlegen, ändern und löschen

Die EntityId stellt die Objekt-ID dar, mit welcher der Link verbunden werden soll. Die Entität selbst wird in der Konfiguration definiert.

Version 1.2

POST /openwowi/v1.2/ExternalLink/EntityLink HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "ExternalLinkConfigurationId": 1,
  "Url": "text",
  "EntityId": 1
}

{
  "EntityLinkId": 1,
  "EntityId": 1
}

PUT /openwowi/v1.2/ExternalLink/EntityLink/{entityLinkId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "Url": "text",
  "EntityId": 1
}

{
  "EntityLinkId": 1,
  "EntityId": 1
}

DELETE /openwowi/v1.2/ExternalLink/EntityLink/{entityLinkId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "EntityLinkId": 1,
  "EntityId": 1
}

Kataloge

Verfügbare Entitäten

Version 1.2

GET /openwowi/v1.2/ExternalLinkCatalog/ExternalLinkEntity HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "Code": "text",
    "EntityName": "text"
  }
]