Adressbuch-API

Über die Adressbuch-API kann ein vorhandenes Unternehmens-Adressbuch in MEMOIO eingebunden werden. Wird nach Kontakten gesucht, etwa beim Starten einer Unterhaltung, so wird automatisch auch das Adressbuch durchsucht. Dasselbe gilt für die Kontaktsuche über die API und über den MCP-Zugang.

MEMOIO hat dabei keinen Zugriff auf Ihre Systeme. Stattdessen stellen Sie eine über das Internet erreichbare URL bereit, an die MEMOIO jede Suche weiterreicht. Ihr System führt die Suche durch, MEMOIO zeigt die gelieferten Kontakte anschließend an. Die URL wird im Unternehmensprofil unter API-Integration im Feld Adressbuch-URL hinterlegt. Im Feld Adressbuch-Name legen Sie einen möglichst kurzen Namen fest, der bei den gefundenen Kontakten als Quelle angezeigt wird. Beide Felder erscheinen nur, wenn Ihr Unternehmen die Funktion „Adressbuch-API“ gebucht hat.

Für eine Suche ruft MEMOIO die URL per GET mit folgenden Parametern auf:

• query – der eingegebene Suchbegriff, in Kleinbuchstaben und ohne Leerzeichen am Anfang und Ende.
• caller – die E-Mail-Adresse der suchenden Person. Erfolgt die Suche nicht im Namen einer Person, sondern über die Schnittstelle des Unternehmens, so entfällt dieser Parameter.

Enthält die URL bereits eigene Parameter, so werden diese beibehalten.

Weiterhin überträgt MEMOIO im Header Authorization einen Access-Token, der aus dem API-Key Ihres Unternehmens berechnet wird. Der API-Key selbst wird dabei nicht übertragen. Durch Prüfen des Access-Tokens stellen Sie sicher, dass die Anfrage tatsächlich von MEMOIO stammt. Wie der Access-Token berechnet und geprüft wird, beschreibt Authentifizierung.

Als Antwort wird ein XML mit folgendem Format erwartet:

<friends>
    <friend>
    <email>Die E-Mail-Adresse des Kontaktes</email>
    <name>Der Name des Kontaktes</name>
    <company>Das Unternehmen des Kontaktes</company>
    <source>Quelle des Kontaktes (kurzer Begriff) - Optional: Sie können im Unternehmensprofil einen Namen für die Adressbuch-Anbindung angeben</source>
    <position>Die Position des Kontaktes</position>
    <phone>Die Telefonnummer des Kontaktes</phone>
    <mobile>Die Handynummer des Kontaktes</mobile>
    <avatar>Ein Avatar-Bild des Kontaktes als absolute, über das Internet erreichbare URL</avatar>
    </friend>
</friends>

Pflichtfeld ist nur email. Einträge ohne E-Mail-Adresse werden übersprungen. Fehlt der Name, so leitet MEMOIO ihn aus der E-Mail-Adresse ab.

Wie viele Kontakte MEMOIO berücksichtigt, hängt davon ab, wo gesucht wird:

• Bei der Suche in MEMOIO selbst übernimmt MEMOIO höchstens 25 Kontakte aus Ihrem Adressbuch, zusätzlich zu den Kontakten, die es selbst findet.
• Bei der Suche über die API (höchstens 50 Kontakte) und über den MCP-Zugang (höchstens 50 Kontakte) gilt die Grenze für die gesamte Liste: Zuerst kommen die Kontakte, die MEMOIO selbst findet, die verbleibenden Plätze füllt Ihr Adressbuch.

Kontakte, die bereits auf anderem Weg gefunden wurden, etwa Kollegen aus dem eigenen Unternehmen, werden nicht doppelt angezeigt und nicht mitgezählt. Alle weiteren Einträge werden ignoriert.

Bei der Suche über die API oder den MCP-Zugang wartet MEMOIO nur begrenzt auf die Antwort Ihres Adressbuchs. Antwortet es nicht rechtzeitig, so schlägt die gesamte Suche fehl, auch für die Kontakte, die MEMOIO selbst gefunden hat.

Optional kann die Antwort ein Element message enthalten, etwa um auf einen Fehler hinzuweisen. Diese Meldung wird protokolliert und in der Konsole des Browsers ausgegeben, den Nutzern aber nicht angezeigt. Bei einer Suche über die API oder den MCP-Zugang enthält das Ergebnis die Meldung als Hinweis.

MEMOIO sortiert die Ergebnisse Ihres Adressbuchs nicht um. Abgesehen von Einträgen ohne E-Mail-Adresse und bereits gefundenen Kontakten erscheinen sie genau in der Reihenfolge, in der Ihr System sie liefert. In der Liste stehen sie unterhalb der Kontakte, die MEMOIO selbst findet, etwa Kollegen oder frühere Gesprächspartner. Wie gut die Suche funktioniert, hängt also allein von Ihrer Umsetzung ab.

Sortieren Sie die Kontakte daher nach Relevanz, den besten Treffer zuerst. Bewährt hat sich, jeden Treffer zu gewichten, zum Beispiel danach,

• ob der Suchbegriff genau oder nur ungefähr übereinstimmt,
• in welchem Feld er gefunden wurde (ein Treffer im Namen zählt mehr als einer in der Adresse),
• wie viele der eingegebenen Wörter gefunden wurden.

Nutzer suchen mit ganz gewöhnlichen Begriffen, etwa „Müller Vertrieb“. Ihre Umsetzung sollte daher keine besondere Suchsyntax voraussetzen.