9.4 JSON-API

JSON-API synchronisieren

So richten Sie eine neue Synchronisierung ein

  1. Wählen Sie in der Seitenleiste JSON API aus.
  2. Klicken Sie neben Neue Datenquelle hinzufügen auf das Symbol „+“.
    ⇒ Im nächsten Bildschirm ist die Verbindung nun auf Aktiviert gesetzt. Passen Sie die Einstellungen nach Bedarf an.

Eine vorhandene Synchronisierung bearbeiten, duplizieren oder löschen

  1. Wählen Sie in der Seitenleiste JSON API aus.
  2. Klicken Sie auf das Stiftsymbol, um die Einstellungen eines JSON-Servers zu bearbeiten.
  3. Klicken Sie auf das Kopiersymbol, um einen JSON-Server zu duplizieren.
  4. Klicken Sie auf das Löschsymbol, um einen JSON-Server zu löschen.

JSON-API-Einstellungen

Name der Einstellung

Beschreibung

Neue Datenquelle hinzufügen

Klicken Sie auf das Symbol +, um eine neue Datenquelle hinzuzufügen.

Aktiviert

Aktiviert die Anfrage an jede JSON-Quelle

Automatischer Import bei Software-Start deaktivieren

Standardmäßig wird der Import beim Start ausgeführt. Deaktivieren Sie diese Funktion, wenn Sie den Import lieber manuell starten möchten.

Datensätze ohne eindeutige Kontakt-ID als neuen Kontakt hinzufügen (AUS = verwirft Datensatz)

Kann aktiviert werden, um einmalig aus einer Quelle ohne eindeutige Kontakt-ID zu importieren. Beachten Sie, dass ein mehrmaliger Import aus einer Quelle ohne eindeutige Kontakt-ID dazu führt, dass dieselben Kontakte mehrfach erstellt werden.

Einmalig von der Quell-URL importieren

Klicken Sie hier, um Kontakte sofort zu importieren.

Verzeichnisname

Freier Name der JSON-Quelle, auf die zugegriffen werden soll

API-Interface

Auswahl einer verfügbaren API-Schnittstelle

Authentifizierungstyp

Dieser Parameter definiert, wie und wo die Authentifizierung stattfindet

Benutzername

Benutzername für Verhandlungsverfahren wie Negotiate

Kennwort

Benutzerkennwort

URL

URL der JSON-Datenquelle

  1. Spalte 1: Attribute lokaler Daten
  2. Spalte 2: JSON-Attribut Geben Sie ein benutzerdefiniertes JSON-Attribut in die bearbeitbaren Felder ein.

JSON-Daten importieren

JSON-Datenquellen-Links
Kontakte können aus JSON-Datenquellen mit einem URL-Link oder Datei-Link importiert werden. URL-Datenquellen sind URLs, auf die ohne Authentifizierung, mit HTTP-AUTH oder oAUTH zugegriffen werden kann.

Statische Dateien
Statische Dateien, die einmalig für den Import erstellt oder zyklisch aktualisiert werden, können ebenfalls verwendet werden.

Einmalige/zyklische Importe
Unabhängig von der Datenquelle können Sie Kontaktdaten „einmalig“ oder zyklisch importieren/synchronisieren.

Eindeutige Kontakt-ID-Vergabe
Eine eindeutige Kontakt-ID-Vergabe ist vorzuziehen, um Duplikate bei zyklischen Importvorgängen zu vermeiden.

Import aus lokalen Datenquellen
Um aus lokalen Datenquellen zu importieren, verwenden Sie bitte eine spezielle Form der Pfadangabe und fügen Sie „file:///” vor der Laufwerksangabe ein, z. B. „file:///d:/json-csv/data.json”.

JSON-Struktur
Die JSON-Struktur unterliegt keinen besonderen Vorgaben. JSON-Objekte können direkt adressiert und für den Import angepasst werden. Dies gilt für einfache Objekte und JSON-Arrays.

Wertzuweisung
Die zu importierenden Daten werden nach dem einfachen Prinzip der Wertzuweisung per Objektpfad zugewiesen:
[Zu importierender Wert] -> [Lokaler Wert]


Beispiel einer einfachen JSON-Struktur für ein einzelnes „Kontakt-Objekt”:

Importbeispiel „Vorname“

Importbeispiel „Postschließfach”

Beim Importieren aus einem Array wird jeder Array-Index überprüft und importiert, sofern nutzbare Daten verfügbar sind.

"numbers": {
  "PRIVATE": [
       {
          "id": "",
          "number_e164": "4964454930560000",
          "number_disp": "4930567890"
       },
       {
          "id": "",
          "number_e164": "4964454930671111",
          "number_disp": "4930678900"
       }
   ]

In bestimmten Fällen ist es erforderlich, die zu importierenden Daten anzupassen. Zu diesem Zweck stehen zwei Funktionen zur Verfügung, die einen Wert während des Datenimports beeinflussen. Diese Funktionen können in der Objektpfadangabe mehrfach kombiniert werden. Funktionen und Objektangaben werden logisch mit „|“ (Pipe) verknüpft.

  • writeIfNotEmpty("<Value>") -> schreibt den Wert nur, wenn das Ergebnis größer als NULL ist.
  • write("<Value>") -> schreibt immer den Wert, unabhängig vom Ergebnis

Beispiel:

writeIfNotEmpty("+")|numbers/PRIVATE/number_e164

Ergebnis:

+4964454930560000

+4964454930671111

Beispiel:

writeIfNotEmpty("+")|numbers/PRIVATE/number_e164|write("123")

Ergebnis:

+4964454930560000123

+4964454930671111123

Besondere Vorgehensweise beim Importieren von Gruppenzuweisungen

Sie können eine Gruppenzuordnung eines Kontakts vornehmen, indem Sie Daten in das Feld Zuordnung zur Kontaktgruppe importieren.

Es gilt Folgendes:

  • Externe Gruppenbezeichnungen haben immer Vorrang vor den Programmgruppen.
    • Die interne Programmgruppe Favoriten ist die einzige Gruppe, die neben den extern bereitgestellten Gruppen verwendet und haptisch zugeordnet werden kann.
    • Gruppennamen werden beim Import NICHT groß-/kleinschreibungsabhängig behandelt. Dadurch werden mehrere Gruppen mit unterschiedlichen Schreibweisen eines Gruppentyps (Freunde, Freunde, FrienDs) vermieden.
    • Importierte Gruppen werden dauerhaft in der Anwendung gespeichert. Nicht mehr benötigte Gruppen müssen Sie in der Gruppenverwaltung löschen. Eine Löschung über JSON ist derzeit nicht vorgesehen.

Beispielgruppen aus einem Array importieren

"groups": [
   {
      "id": "14741",
      "name": "Friends",
      "desc": "Friends"
   },
   {
      "id": "14744",
      "name": "Partner",
      "desc": ""
   }
]

Sollten keine Kontaktgruppen mit den Namen „Friends“ und „Partner“ vorhanden sein, werden diese erstellt. Der aktuell importierte Kontakt wird ebenfalls den Gruppen „Friends“ und „Partner“ zugeordnet.

Importieren von Bilddateien

Bilddaten werden stets im JPEG-Bildformat erwartet. Für den Import müssen Sie JPEG-Dateien in das BASE64-Format konvertieren.