Hilfe-Center / Für Entwickler

API

Tokens, Konten, Anfragelimits und wo Sie die vollständige Referenz finden.

Vollständige Referenz

Jeder Endpunkt, jeder Parameter und jede Antwort steht in der API-Referenz, erzeugt aus unserer OpenAPI-Beschreibung unter /openapi.yaml.

Tokens

Erstellen Sie ein Token unter Einstellungen › API-Tokens. Wählen Sie Nur lesen für Dashboards und Statusabfragen oder Lesen und schreiben, um Änderungen vorzunehmen, und auf Wunsch, wann es abläuft. Das Token wird nur einmal angezeigt, beim Erstellen, kopieren Sie es also gleich: Wir speichern nur eine verschlüsselte Fassung. Senden Sie es als Bearer-Token:

curl https://pingerer.com/api/v1/sites \
  -H "Authorization: Bearer YOUR-TOKEN"

Das Konto wählen

Wenn Sie zu mehreren Konten gehören, wählen Sie eines mit dem Header Pingerer-Account (die ID des Kontos) oder einem Parameter account_id. Sonst wird das Konto des Tokens verwendet, danach Ihr erstes Teamkonto.

Was Sie tun können

  • Websites und Überwachungen: auflisten, hinzufügen, ändern, pausieren, fortsetzen, sofort testen, Ergebnisse, Verfügbarkeit. Dazu gehört auch das Verlängerungsdatum für Domains, deren Registry es nicht veröffentlicht (renews_on).
  • Website-Zustand: der Gesundheitswert jeder Website und was zu beheben ist, und eine erneute Prüfung sofort.
  • Störungen: auflisten, übernehmen, Notizen hinzufügen, beheben. Wenn wahrscheinlich Ihr Hoster die Ursache ist, nennt die Störung das Unternehmen.
  • Heartbeats, Benachrichtigungskanäle und Ruhezeiten (mit Ihrem Wochenende).
  • Wartungsfenster, Statusseiten und Updates (mit ihren Badge-Adressen) und Monatsberichte.
  • Werkzeuge: wie eine Seite aussieht, wenn ihr Link geteilt wird, und das Internetwetter (welche Hoster und CDNs gerade Probleme haben).
  • GET /api/v1/status für ein schnelles „Ist alles erreichbar?“.

Tokens von Mitgliedern können lesen und Störungen übernehmen; für Änderungen braucht es das Token eines Admins.

Webhooks

Um Benachrichtigungen in Ihrem eigenen Code zu empfangen, fügen Sie einen Webhook-Benachrichtigungskanal hinzu. Jede Benachrichtigung ist ein signierter JSON-POST; unter Benachrichtigungen und Kanäle sehen Sie, was er enthält und wie Sie die Signatur prüfen.

Antworten und Fehler

Antworten sind JSON in der Form {"data": ..., "meta": ...}. Fehler sind {"error": "code", "message": "...", "details": ...}. Wer eine Tarifgrenze überschreitet, bekommt 422 mit plan_limit; ein Nur-Lese-Token, das schreiben will, bekommt 403 read_only_token.

Anfragelimits

300 Anfragen pro Minute und Token. Darüber bekommen Sie 429; warten Sie kurz und versuchen Sie es erneut.

Kommen Sie nicht weiter? Schreiben Sie uns, ein Mensch antwortet Ihnen.