Skip to main content

API-Zugriff für AI Answers einrichten

Mit der AI Answers API können Ihre eigenen Anwendungen Fragen zum Inhalt eines Nexus-Projekts senden und Antworten erhalten. Sie können damit beispielsweise einen Slackbot erstellen oder Antworten auf Ihrer eigenen Support-Website hinzufügen.

Sie verwalten die API im Abschnitt API auf der Registerkarte AI Answers . Der Abschnitt umfasst zwei Registerkarten. Auf der Registerkarte Zugriff aktivieren Sie die API und legen fest, wer eine Verbindung herstellen darf. Auf der Registerkarte API-Schlüssel erstellen und widerrufen Sie Schlüssel.

So aktivieren oder deaktivieren Sie die API:

  1. Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  2. Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  3. Wählen Sie die Registerkarte AI-Antworten aus.

  4. Wählen Sie im Abschnitt API den API -Schalter aus.

  5. Wenn das Projekt über API-Schlüssel verfügt, wird ein Bestätigungsdialogfeld geöffnet. Wählen Sie Aktivieren oder Deaktivieren.

Wenn Sie die API aktivieren, ist die Option API-Schlüssel erforderlich standardmäßig ausgewählt.

Anmerkung

Ihre API-Schlüssel bleiben in der Liste, solange die API deaktiviert ist, sodass Sie sie weiterhin widerrufen können. Keiner davon wird akzeptiert, bis Sie die API wieder aktivieren.

Sie können diese Einstellung nur ändern, solange die API aktiviert ist. So legen Sie fest, wer eine Verbindung herstellen darf:

  1. Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  2. Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  3. Wählen Sie die Registerkarte KI-Antworten aus.

  4. Wählen Sie im Abschnitt API die Registerkarte Zugriff aus.

  5. Wählen Sie aus, wer eine Verbindung herstellen darf:

    • Öffentlich: Es ist kein API-Schlüssel erforderlich. Jede Anwendung, die die API-Adresse kennt, kann eine Verbindung herstellen.

    • API-Schlüssel erforderlich: Nur Anwendungen, die einen der API-Schlüssel dieses Projekts übermitteln, können eine Verbindung herstellen.

Ihre Auswahl wird gespeichert, sobald Sie sie auswählen.

Ihre Entwickler benötigen drei Werte, um Anfragen zu senden. Diese befinden sich alle auf der Registerkarte Zugriff und verfügen jeweils über eine Schaltfläche Kopieren :

  • API-Adresse: Hier senden Ihre Anwendungen ihre Anfragen für dieses Projekt hin.

  • Mieter-ID: für alle Ihre Projekte gleich.

  • Projekt-ID: eindeutig für dieses Projekt.

Für jede Anfrage werden beide IDs benötigt. Informationen zum Senden einer Anfrage finden Sie unter AI Answers – API-Referenz.

So erstellen Sie einen API-Schlüssel:

  1. Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  2. Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  3. Wählen Sie die Registerkarte AI-Antworten aus.

  4. Wählen Sie im Bereich API die Registerkarte API-Schlüssel aus.

  5. Wählen Sie API-Schlüssel erstellenaus. Wenn das Projekt noch keine Schlüssel hat, heißt die Schaltfläche Schlüssel erstellen.

  6. Geben Sie im Feld „Name“ einen Namen ein, der Ihnen verdeutlicht, wozu der Schlüssel dient. Zum Beispiel „Support-Portal“.

  7. Wählen Sie API-Schlüssel erstellenaus.

  8. Wählen Sie Kopieren, um den Schlüssel zu kopieren, und bewahren Sie ihn an einem sicheren Ort auf.

  9. Wählen Sie Fertig.

Wichtig

Der Schlüssel wird nur einmal angezeigt. Wenn Sie ihn verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.

Die Liste enthält den Namen jedes Schlüssels und einen kurzen Ausschnitt aus dem Schlüssel, damit Sie Ihre Schlüssel voneinander unterscheiden können.

Durch das Widerrufen eines Schlüssels erhalten Anwendungen, die diesen Schlüssel verwenden, keine Antworten mehr. Ihre anderen Schlüssel funktionieren weiterhin. Dieser Vorgang kann nicht rückgängig gemacht werden.

So widerrufen Sie einen Schlüssel:

  1. Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  2. Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  3. Wählen Sie die Registerkarte AI-Antworten aus.

  4. Wählen Sie im Abschnitt API die Registerkarte API-Schlüssel aus.

  5. Wählen Sie Widerrufen neben dem Schlüssel aus.

  6. Wählen Sie im Bestätigungsdialogfeld die Option API-Schlüssel widerrufenaus.

  • Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  • Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  • Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  • Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  • Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  • Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.

  • Wählen Sie Nexus im oberen Menü. Es wird Ihnen die Liste der aktuellen Nexus-Projekte angezeigt.

    260810_Nexus_Tab.png
  • Rufen Sie das Projekt auf, das Sie konfigurieren möchten, indem Sie es in der Liste auswählen.