Zum Hauptinhalt springen

Leitfaden zu API-Protokollen

Heute aktualisiert

Überblick

Die Seite für API-Protokolle zeigt Ihnen in Echtzeit, was mit Ihrer API-Aktivität in Ihrem gesamten Konto passiert. Sie wurde entwickelt, um Ihnen Sicherheit zu geben, damit Sie schnell sehen können, was funktioniert, Probleme frühzeitig erkennen und verstehen können, wie Ihre Systeme kommunizieren.

Protokolle werden 7 Tage lang aufbewahrt und umfassen:

  • Erfolgreiche Anfragen

  • Fehlgeschlagene Anfragen

  • Detaillierte Protokolle für jede Anfrage

  • Vollständige Anfrage- und Antwort-Payloads

Sie können diese Seite verwenden, um zu überprüfen, ob Anfragen erfolgreich zugestellt wurden, Fehler zu untersuchen und die Aktivitäten über Ihre verbundenen Dienste hinweg in einer einfachen Ansicht zu verfolgen.


Aufrufen der Seite für API-Protokolle

  1. Suchen Sie im linken Menü nach Entwickler.

image-20260123-040549.png


Komponenten

1. Zusammenfassung: 'Ihre letzten Aktivitäten'

Diese Metriken geben Ihnen sofortige Transparenz über Ihre API-Nutzung.
Zeigt die Gesamtzahlen für den ausgewählten Datumsbereich an:

  • Gesamte Anfragen: Alle getätigten API-Anfragen.

  • Erfolgreich: Anfragen, die die Status 200 und 201 zurückgeben

  • Fehlgeschlagen: Anfragen, die die Status 400, 401, 403, 404 und 50 zurückgeben

2. Suche, Filter & Anwenden

Die Such- und Filterfunktion hilft Ihnen, die gesuchten Protokolle schnell zu finden. Sie können nach Schlüsselwörtern suchen, nach Status filtern oder nach Datum eingrenzen, um sich auf die Anfragen zu konzentrieren, die am wichtigsten sind.

Diese Funktionalität gilt für die vier Seiten mit Protokollen, die anfänglich geladen werden. Um mehr Datensätze zu durchsuchen oder zu filtern, laden Sie einfach zusätzliche Seiten, indem Sie auf die nächsten Seiten klicken. Ihre Suche und Filter werden dann auch auf die neu geladenen Protokolle angewendet.

  • Suchen

    Geben Sie vollständige oder teilweise Wörter ein, und die Suche durchsucht alle folgenden Felder, um Ihnen zu helfen, schnell zu finden, was Sie benötigen.
    Hier sind die möglichen Suchoptionen:

    • API-Endpunkt: Der spezifische API-Pfad, der aufgerufen wird.

    • Anfrage-ID: Eine eindeutige Kennung, die jeder API-Anfrage automatisch zugewiesen wird.

    • Quelle: Woher die Anfrage stammt (z. B. API, Dashboard, Unterkonto).

    • Body: Der Inhalt der Anfrage, einschließlich Nachrichtentext und Parametern.

    • Land: Das Zielland der Nachricht basierend auf der Empfängernummer.

    • Absender-ID: Der "from"-Wert, der beim Versenden der Nachricht verwendet wird (alphanumerisch oder Nummer).

    • Antwortcode: Der numerische Code des Systems, der nach der Verarbeitung der Anfrage zurückgegeben wird.

    • Antwortnachricht: Eine kurze Nachricht, die den Antwortcode erklärt.

    • Fehlercode: der HTTP-Status des Aufrufs

    • Fehlermeldung: Eine kurze Erklärung, was den Fehler verursacht hat.

    • Nachrichten-ID: Die eindeutige Kennung für die einzelne Nachricht, sobald sie in die Warteschlange gestellt oder versendet wurde.

  • Filter

    • Status: Filtern nach Erfolg, Client-Fehlern oder Server-Fehlern.

    • Endpunkt: Filtern nach z. B. /v3/sms/send, /v3/mms/send, /v3/sms/history usw.

    • Unterkonto: Standardmäßig ist dies Ihr Unterkonto.

    • Datumsbereich: Wir bewahren die Protokolle nur 7 Tage lang auf. Sie können aus diesen Optionen wählen:

      • Heute

      • Letzte 12 Stunden

      • Letzte 24 Stunden

      • Vor 2 Tagen

      • Vor 3 Tagen

      • Vor 4 Tagen

      • Vor 5 Tagen

      • Vor 6 Tagen

    Hinweis: Wenn Sie den Filter ‚Vor 2 Tagen‘ verwenden, werden alle Protokolle der vergangenen zwei Tage angezeigt, einschließlich des heutigen Tages.

  • Buttons

    • Filter zurücksetzen: Setzt alle Filter einschließlich der Suche zurück.

    • Anwenden: Verwenden Sie dies, um Ihre aktuellen Filter und die Suche anzuwenden. Sie können entweder auf ‚Anwenden‘ klicken oder einfach die Eingabetaste drücken, um die Suche auszuführen.

3. Protokolltabelle

Zeigt alle API-Anfragen basierend auf Ihren Filtern an. Zu den Spalten gehören:

Verwenden Sie diese Tabelle, um Aktivitäten schnell zu überprüfen oder fehlschlagende Aufrufe zu identifizieren.

Sortierung:

  • Sie können nach einer beliebigen Spalte wie Zeitstempel oder Status sortieren.

  • Ein Klick auf eine Spaltenkopfzeile schaltet zwischen aufsteigender und absteigender Reihenfolge um.

  • Dies hilft Ihnen, Fehler, jüngste Aktivitäten oder spezifische Endpunkte effizienter zu gruppieren.

Interaktionen:

  • Ein Klick auf eine Zeile öffnet die vollständigen Details der Anfrage im rechten Bereich.

  • Die Paginierung ermöglicht es Ihnen, alle Protokolle zu durchsuchen und weitere Daten zu laden.

  • Tabelle aktualisieren lädt die neuesten Protokolle neu.

  • Sortierung sortieren

  1. Detaillierte Protokollbereiche (Metadaten-, Anfrage- und Antwortbereiche)

    Wenn Sie eine Zeile auswählen, werden die vollständigen Details angezeigt.

    Der Metadatenbereich umfasst:

    • Methode

    • Status

    • Nachrichtenstatus (z. B. 200 Erfolg)

    • Anfrage-ID

    • Unterkonto

    • Zeitstempel

    • Client-IP-Adresse

    • User-Agent

    Dieser Abschnitt hilft zu identifizieren, woher die Anfrage stammte (Postman, Server, Browser usw.).

    Anfrage-Body

    Zeigt die genauen versendeten Nutzdaten an. Nützlich für:

    • Fehlerbehebung bei fehlerhaftem JSON

    • Überprüfung von Parametern

    • Überprüfung von Authentifizierungsmethoden

    Antwort-Body

    Zeigt die genaue zurückgegebene Antwort an. Beinhaltet:

    • HTTP-Codes

    • Fehlermeldungen

    • Interne Antwortcodes

    • Zustellungsdaten und Preisgestaltung (falls zutreffend)

    Dies ist Ihr wichtigstes Tool zur Fehlerbehebung bei Problemen wie Ausfällen, Nachrichtenfehlern oder inkorrekten Nutzdaten.


Häufige Anwendungsfälle

1. Fehlerbehebung bei fehlgeschlagenen API-Anrufen

  1. Öffnen Sie das Status-Dropdown des Filters

  2. Klicken Sie auf eine Zeile mit 400 oder 500.

  3. Überprüfen:

    • Antwort-Body (Fehlermeldung)

    • Anfrage-Body (falsche Felder?)

    • Verwendeter Endpunkt

    • Unterkonto, das ihn ausgelöst hat

2. Bestätigung, dass Telekommunikationsdienst/Multimedia Messaging Service erfolgreich versendet wurde

  1. Filtern Sie den Endpunkt /v3/sms/send.

  2. Überprüfen Sie den Status 200.

  3. Untersuchen Sie den Antwort-Body → Message queued for delivery.

3. Reproduktion oder Eskalation von Problemen

Kopieren Sie die Anfrage-/Antwort-Bodys direkt, wenn Sie Probleme melden.

Tipps

  • Verwenden Sie die Suche, um schnell Protokolle für eine bestimmte Telefonnummer oder ein Schlüsselwort zu finden.

  • Bei wiederkehrenden Problemen vergleichen Sie mehrere Protokolle nebeneinander.

  • Protokolle werden automatisch aktualisiert, wenn auf Tabelle aktualisieren geklickt wird.

  • Nutzen Sie die Antwort-Nutzdaten, um Probleme bei der Preisgestaltung oder Zustellung zu verstehen.


FAQS

Was ist die Seite API-Protokolle?

Die Seite API-Protokolle ermöglicht es Entwicklern, alle über ihr Konto getätigten API-Anfragen einzusehen und zu überwachen. Sie hilft dabei, Anfrageaktivitäten zu verfolgen, Fehler zu identifizieren und die Fehlerbehebung bei Integrationen in Echtzeit durchzuführen.

Welche Informationen kann ich in den API-Protokollen sehen?

Jeder Protokolleintrag enthält wichtige Details wie:

  • Zeitstempel – Wann die Anfrage gestellt wurde

  • Endpunkt – Welcher API-Endpunkt aufgerufen wurde

  • Status – Ob die Anfrage erfolgreich war oder fehlgeschlagen ist

  • Antwortcode – HTTP-Statuscode (z. B. 200, 400, 500)

  • Anfrage-ID – Ein eindeutiger Identifikator für jede Anfrage

Was sind die Zähler „Alle“, „Erfolgreich“ und „Fehlgeschlagen“?

Diese Zähler fassen Ihre API-Anfrageaktivität zusammen:

  • Alle – Zeigt die Gesamtzahl der getätigten API-Anrufe an

  • Erfolgreich – Zeigt die Anzahl der erfolgreich abgeschlossenen Anfragen an

  • Fehlgeschlagen – Zeigt die Anzahl der Anfragen an, die zu einem Fehler geführt haben

Wie funktioniert die Paginierung auf der Protokollseite?

Protokolle werden in Seiten angezeigt, um das Durchsuchen schneller und einfacher zu machen.

Verwenden Sie die Paginierungssteuerungen (z. B. Weiter, Zurück oder nummerierte Seiten), um durch Ihren Protokollverlauf zu navigieren.

Was macht der Button „Aktualisieren“?

Der Button Aktualisieren lädt die Protokolltabelle neu, um die jüngsten API-Aktivitäten anzuzeigen, ohne das gesamte Dashboard neu zu laden.

Dies ist nützlich bei der Überwachung von Live-API-Anfragen.

Wie oft werden Protokolle aktualisiert?

Protokolle werden in nahezu Echtzeit aktualisiert. Sie können manuell auf Aktualisieren klicken, um die neuesten Daten sofort zu erhalten.

Wie weit zurück kann ich API-Protokolle einsehen?

Sie können Protokolle der vergangenen 7 Tage einsehen.

Ältere Protokolle können automatisch archiviert oder gelöscht werden.

Kann ich meine API-Protokolle exportieren?

Derzeit ist die Exportfunktion möglicherweise nicht direkt auf der Seite verfügbar.

Kann ich meine API-Protokolle durchsuchen oder filtern?

Ja. Sie können Protokolle filtern nach:

  • Status (Erfolgreich, Fehlgeschlagen)

  • Datumsbereich

  • Endpunkt

  • Suche - ein beliebiges Schlüsselwort eingeben

Was soll ich tun, wenn eine Anfrage fehlgeschlagen ist?

Sie können:

  • Klicken Sie auf den fehlgeschlagenen Protokolleintrag, um Details und Fehlermeldungen einzusehen

  • Überprüfen Sie den Antwortcode und den Fehler-Body

  • Verwenden Sie diese Daten, um Fehler in Ihrer API-Integration zu beheben

Wer kann auf die Seite API-Protokolle zugreifen?

Konto und Unterkonto können auf ihre API-Protokolle zugreifen und diese einsehen. In dieser Version ist es so eingerichtet, dass das Unterkonto nur seine eigenen ansehen kann.

Hat dies deine Frage beantwortet?