API-Nutzung

Anwendungsprogrammierschnittstellen (APIs) sind eine Reihe von Regeln und Protokollen, die zur Erstellung und Interaktion mit Softwareanwendungen verwendet werden. Sie ermöglichen es verschiedenen Softwaresystemen, miteinander zu kommunizieren.

Die Seite „API-Nutzung“ in Zoho Books bietet einen Überblick über alle API-Aufrufe, die an Ihre Organisation gerichtet wurden, mit Ausnahme der von der Webanwendung ausgeführten. Sie können detaillierte Informationen zu jedem API-Aufruf erhalten, der von Drittanwendungen, Deluge-Skripten in Zoho Books oder anderen Zoho-Anwendungen ausgeführt wurde. Außerdem können Sie die statistischen Diagramme im Dashboard nutzen, um einen Überblick über die API-Nutzung, die Top-API-Benutzer, den Nutzungszeitraum, die Details zu den letzten API-Aufrufen und weitere Informationen zu erhalten.

Um die API-Nutzung Ihrer Organisation anzuzeigen:

Klicken Sie im oberen rechten Bereich der Seite auf Einstellungen.
Klicken Sie unter Entwicklungsraum auf API-Nutzung.

Sie können die API-Übersichtsseite aufrufen, um die API-Nutzungsdaten Ihrer Organisation zu erhalten.

Domain Typ

Ab dem 1. Juni 2024 haben wir einen neuen Domain (www.zohoapis.com/books) für APIs hinzugefügt. Der Filter „Domain Typ“ im oberen rechten Bereich der Seite ermöglicht es Ihnen, alle Ihre APIs, die alte (/books.zoho.com/api/), und die neuen (www.zohoapis.com/books/) APIs anzuzeigen.

Domain Typ	Beschreibung
Alle Domains	Listet sowohl die neuen als auch die alten Domain-Nutzung auf.
Neue Domain	Listet nur die neue Domain-Nutzung auf.
Alte Domain	Listet nur die alte Domain-Nutzung auf.

API-Nutzung heute

Erfahren Sie, wie viele API-Aufrufe für den heutigen Tag verfügbar sind. Das Balkendiagramm zeigt die bereits verwendeten Aufrufe und die verbleibenden Aufrufe, die noch getätigt werden können.

Verwaltung der Benachrichtigung bei Nutzungsgrenze

Sie können Benachrichtigungen einrichten, um Benutzer zu informieren, wenn die API-Nutzung für einen Tag die festgelegte Grenze überschreitet. So funktioniert das:

Klicken Sie im oberen rechten Bereich der Seite auf Einstellungen.
Klicken Sie unter Entwicklungsraum auf API-Nutzung.
Klicken Sie unter API-Nutzung heute auf Verwaltung der Benachrichtigung bei Nutzungsgrenze.
Wählen Sie den API-Nutzung (%), bei dem Benutzer Benachrichtigungen erhalten sollen. Sie können mehrere Grenzwerte in 5er-Schritten auswählen.
Wählen Sie die E-Mail-Empfänger aus. Wenn Admins als E-Mail-Empfänger hinzugefügt werden, erhalten sie auch Benachrichtigungen innerhalb der Anwendung.
Klicken Sie auf Vorab-Nachricht senden, um zu prüfen, ob die Benachrichtigungen ordnungsgemäß funktionieren.
Klicken Sie auf Speichern.

Nutzungszeitreihe

Verwenden Sie den Linienchart, um die Anzahl der API-Aufrufe pro Tag für die letzten 30 Tage in Ihrer Organisation zu sehen. Positionieren Sie den Mauszeiger über einen Punkt eines bestimmten Datums, um die Anzahl der Aufrufe an diesem Tag zu erfahren. Diese Informationen werden alle drei Stunden aktualisiert.

Top-API-Nutzungsbalken

In diesem Abschnitt können Sie die Top-5-API-Nutzungsdetails mithilfe von Kreisdiagrammen anzeigen. Klicken Sie auf das Diagramm, um weitere Details zu den API-Aufrufen zu sehen. Wenn Sie Details aus der vorherigen Woche oder dem vorherigen Monat anzeigen möchten, klicken Sie auf das Heute-Dropdown in der oberen rechten Ecke des Abschnitts und wählen Sie die gewünschte Dauer aus, für die Sie die API-Nutzungsdetails ansehen möchten. Diese Informationen werden alle drei Stunden aktualisiert.

In diesem Abschnitt können Sie folgende Inhalte anzeigen:

Top 5 Module

Zeigen Sie die fünf häufigsten Module an, für die die Benutzer in Ihrer Organisation API-Aufrufe tätigen.

Um modulebasierte API-Aufrufe für einen bestimmten Zeitraum anzuzeigen:

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie unter Developer Space auf API-Nutzung.
Gehen Sie zum Abschnitt Top-API-Nutzungsbalken.
Positionieren Sie den Mauszeiger über Top 5 Module und klicken Sie auf Alle anzeigen.

Der Bericht zur Nutzung pro Modul. Er zeigt die API-Nutzung pro Modul für den angegebenen Zeitraum.

Sie können die API-Aufrufe nach Modulen filtern, indem Sie auf den Filter Alle klicken.
Sie können auch den Bericht anpassen. Klicken Sie auf Bericht anpassen oben.
Wählen Sie einen Datumsbereich und eine Art aus.
Klicken Sie auf Bericht ausführen.

Die API-Aufrufe, die aus verschiedenen Modulen innerhalb des angegebenen Zeitraums stammen, werden angezeigt.

Top 5 Anwendungen

Zeigen Sie die fünf häufigsten Module an, für die die Benutzer in Ihrer Organisation API-Aufrufe tätigen.

Hinweis:Der in diesem Abschnitt genannte Anwendungsname bezieht sich auf den Namen, der in der Zoho-API-Konsole verwendet wird, nicht auf den tatsächlichen Namen der Anwendung.

Um die API-Aufrufe zu sehen, die von einer Anwendung innerhalb eines bestimmten Zeitraums ausgeführt wurden:

Klicken Sie im oberen rechten Bereich der Seite auf Einstellungen.
Klicken Sie unter Entwicklungsraum auf API-Nutzung.
Gehe zu dem Abschnitt Top-API-Nutzung-Charts.
Hovern Sie über Top 5 Anwendungen und klicken Sie auf Alle anzeigen.

Der Bericht über die Nutzung nach Anwendung. Er zeigt die API-Nutzung nach Anwendungen für den angegebenen Zeitraum an.

Sie können die API-Aufrufe nach Anwendungen filtern, indem Sie den Filter Alle klicken.
Sie können auch den Bericht anpassen. Klicken Sie oben auf Anpassen.
Wählen Sie einen Datumsbereich und eine Art aus.
Klicken Sie auf Bericht ausführen.

Die API-Aufrufe, die von verschiedenen ausgewählten Anwendungen innerhalb des angegebenen Zeitraums erfolgt sind, werden angezeigt.

Top 5 IP-Adressen

Die fünf IP-Adressen anzeigen, aus denen die meisten Aufrufe erfolgt sind.

Um die API-Aufrufe von einer bestimmten IP-Adresse für einen bestimmten Zeitraum zu sehen:

Klicken Sie im oberen rechten Bereich der Seite auf Einstellungen.
Klicken Sie unter Entwicklungsraum auf API-Nutzung.
Gehe zu dem Abschnitt Top-API-Nutzung-Charts.
Hovern Sie über Top 5 IP-Adressen und klicken Sie auf Alle anzeigen.

Der Bericht über die Nutzung nach IP-Adressen. Er zeigt die API-Nutzung nach IP-Adressen für den angegebenen Zeitraum an.

Sie können die API-Aufrufe nach IP-Adressen filtern, indem Sie den Filter Alle klicken.
Sie können auch den Bericht anpassen. Klicken Sie oben auf Bericht anpassen.
Wählen Sie einen Datumsbereich und eine Art aus.
Klicken Sie auf Bericht ausführen.

Die API-Aufrufe, die von verschiedenen IP-Adressen innerhalb des angegebenen Zeitraums erfolgt sind, werden angezeigt.

Top 5 Benutzer

Die fünf Benutzer anzeigen, die die meisten Aufrufe vorgenommen haben.

Um benutzerbezogene API-Aufrufe zu sehen:

Klicken Sie im oberen rechten Bereich der Seite auf Einstellungen.
Klicken Sie unter Entwicklungsraum auf API-Nutzung.
Gehe zu dem Abschnitt Top-API-Nutzung-Charts.
Hovern Sie über Top 5 IP-Adressen und klicken Sie auf Alle anzeigen.

Der Bericht über die Nutzung nach Benutzern. Er zeigt die API-Nutzung nach Benutzern für den angegebenen Zeitraum an.

Sie können die API-Aufrufe nach Benutzern filtern, indem Sie den Filter Alle klicken.
Sie können auch den Bericht anpassen. Klicken Sie oben auf Bericht anpassen.
Wählen Sie einen Datumsbereich und eine Art aus.
Klicken Sie auf Bericht ausführen.

Die API-Aufrufe, die von Benutzern Ihrer Organisation innerhalb des angegebenen Zeitraums erfolgt sind, werden angezeigt.

Letzte Aktivitäten

Die Details der letzten API-Aufrufe, wie der Benutzer, der den Aufruf getätigt hat, das Modul, für das der Aufruf erfolgt ist, die IP-Adresse und die Anwendung, aus der der Aufruf erfolgt ist, sowie das Datum und die Uhrzeit des Aufrufs, werden im Abschnitt Letzte Aktivitäten angezeigt. Diese Informationen werden alle drei Stunden aktualisiert.