API-Nutzung

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

Die API-Nutzungsseite von Zoho Books bietet Einblicke in alle API-Aufrufe, die an Ihre Organisation gerichtet sind, mit Ausnahme derjenigen, die von der Webanwendung aus getätigt wurden. Sie können Details zu jedem API-Aufruf einsehen, der von Drittanbieter-Apps, Deluge-Skripten in Zoho Books und anderen Zoho-Apps getätigt wurde. Außerdem können Sie die statistischen Diagramme im Dashboard nutzen, um einen Überblick über die API-Nutzung, die Top-API-Benutzer, die Nutzungszeitlinie, Details zu aktuellen API-Aufrufen und andere Informationen zu erhalten.

Um die API-Nutzung Ihrer Organisation anzuzeigen:

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie auf API-Nutzung unter Entwicklerbereich.

Sie können das API-Dashboard anzeigen, von dem aus Sie die API-Nutzungsdetails Ihrer Organisation abrufen können.

Domänentyp

Ab dem 1. Juni 2024 haben wir eine neue Domäne (www.zohoapis.com/books) für APIs hinzugefügt. Der Domänentyp-Filter in der oberen rechten Ecke der Seite ermöglicht es Ihnen, alle Ihre APIs, die alte (/books.zoho.com/api/) und die neue (www.zohoapis.com/books/) APIs anzuzeigen.

Domänentyp	Beschreibung
Alle Domänen	Listet sowohl die Nutzung der neuen als auch der alten Domäne auf.
Neue Domäne	Listet nur die Nutzung der neuen Domäne auf.
Alte Domäne	Listet nur die Nutzung der alten Domäne auf.

API-Nutzung bis heute

Erfahren Sie, wie viele API-Aufrufe für den Tag verfügbar sind. Das Balkendiagramm zeigt die verwendeten Aufrufe und die verbleibende Anzahl von Aufrufen, die getätigt werden können.

Benachrichtigung zur Nutzungslimit-Konfiguration

Sie können Benachrichtigungen konfigurieren, um Benutzer daran zu erinnern, wenn die API-Nutzung für einen Tag den festgelegten Schwellenwert überschreitet. So geht’s:

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie auf API-Nutzung unter Entwicklerbereich.
Klicken Sie auf Benachrichtigung zur Nutzungslimit-Konfiguration unter API-Nutzung bis heute.
Wählen Sie den API-Nutzungs (%)-Wert aus, bei dem Benutzer Benachrichtigungen erhalten sollen. Sie können mehrere Limits in Schritten von 5 auswählen.
Wählen Sie die E-Mail-Empfänger aus. Wenn Administratoren als E-Mail-Empfänger hinzugefügt werden, erhalten sie auch In-App-Benachrichtigungen.
Klicken Sie auf Beispielbenachrichtigung senden, um zu überprüfen, ob die Benachrichtigungen ordnungsgemäß funktionieren.
Klicken Sie auf Speichern.

Nutzungstimeline

Verwenden Sie das Liniendiagramm, um die Anzahl der API-Aufrufe zu sehen, die in den letzten 30 Tagen in Ihrer Organisation pro Tag getätigt wurden. Fahren Sie mit der Maus über den Punkt an einem bestimmten Datum, um die Anzahl der an diesem Datum getätigten Aufrufe zu erfahren. Diese Informationen werden alle 3 Stunden aktualisiert.

Top API-Nutzungsdiagramme

In diesem Abschnitt können Sie die Top 5 API-Nutzungsdetails mit Hilfe von Donut-Diagrammen anzeigen. Sie können auf das Diagramm klicken, um weitere Details zu den API-Aufrufen zu sehen. Wenn Sie Details aus der vorherigen Woche oder dem letzten Monat anzeigen möchten, können Sie im rechten oberen Bereich des Abschnitts auf das Dropdown-Menü Heute klicken und die gewünschte Dauer auswählen, für die Sie die API-Nutzungsdetails anzeigen möchten. Diese Informationen werden alle 3 Stunden aktualisiert.

In diesem Abschnitt können Sie Folgendes anzeigen:

Top 5 Module

Sehen Sie sich die Top 5 Module an, für die die API-Aufrufe von den Benutzern in Ihrer Organisation getätigt wurden.

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

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie auf API-Nutzung unter Entwicklerbereich.
Gehen Sie zum Abschnitt Top API-Nutzungsdiagramme.
Fahren Sie mit der Maus über Top 5 Module und klicken Sie auf Alle anzeigen.

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

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

API-Aufrufe, die aus verschiedenen Modulen innerhalb des angegebenen Zeitraums getätigt wurden, werden angezeigt.

Top 5 Anwendungen

Sehen Sie sich die Top 5 Module an, für die die API-Aufrufe von den Benutzern in Ihrer Organisation getätigt wurden.

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

Um die API-Aufrufe anzuzeigen, die von einer Anwendung für einen bestimmten Zeitraum getätigt wurden:

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie auf API-Nutzung unter Entwicklerbereich.
Gehen Sie zum Abschnitt Top API-Nutzungsdiagramme.
Fahren Sie mit der Maus über Top 5 Anwendungen und klicken Sie auf Alle anzeigen.

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

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

API-Aufrufe, die von verschiedenen ausgewählten Anwendungen innerhalb des angegebenen Zeitraums getätigt wurden, werden angezeigt.

Top 5 IP-Adressen

Sehen Sie sich die 5 IP-Adressen an, von denen die meisten Aufrufe getätigt wurden.

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

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie auf API-Nutzung unter Entwicklerbereich.
Gehen Sie zum Abschnitt Top API-Nutzungsdiagramme.
Fahren Sie mit der Maus über Top 5 IP-Adressen und klicken Sie auf Alle anzeigen.

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

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

API-Aufrufe, die von verschiedenen IP-Adressen innerhalb des angegebenen Zeitraums getätigt wurden, werden angezeigt.

Top 5 Benutzer

Sehen Sie sich die 5 Benutzer an, die die meisten Aufrufe getätigt haben.

Um die API-Aufrufe benutzerweise anzuzeigen:

Klicken Sie auf Einstellungen in der oberen rechten Ecke der Seite.
Klicken Sie auf API-Nutzung unter Entwicklerbereich.
Gehen Sie zum Abschnitt Top API-Nutzungsdiagramme.
Fahren Sie mit der Maus über Top 5 IP-Adressen und klicken Sie auf Alle anzeigen.

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

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

API-Aufrufe, die von Benutzern Ihrer Organisation innerhalb des angegebenen Zeitraums getätigt wurden, werden angezeigt.

Kürzliche Aktivitäten

Die Details der kürzlichen API-Aufrufe, wie der Benutzer, der den Aufruf getätigt hat, das Modul, für das der Aufruf getätigt wurde, die IP-Adresse und die Anwendung, von der der Aufruf getätigt wurde, sowie die Uhrzeit und das Datum, zu dem der Aufruf getätigt wurde, werden im Abschnitt Kürzliche Aktivitäten angezeigt. Diese Informationen werden alle 3 Stunden aktualisiert.