Centre d'aide / Développeurs

API

Jetons, comptes, limites de requêtes et où trouver la référence complète.

Référence complète

Chaque point d'accès, paramètre et réponse figure dans la référence de l'API, générée à partir de notre description OpenAPI sur /openapi.yaml.

Jetons

Créez un jeton dans Paramètres › Jetons d'API. Choisissez Lecture seule pour les tableaux de bord et les contrôles de statut, Lecture et écriture pour faire des modifications, et éventuellement une date d'expiration. Le jeton n'est affiché qu'une fois, au moment où vous le créez : copiez-le à ce moment-là, car nous n'en gardons qu'une copie brouillée. Envoyez-le comme jeton « bearer » :

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

Choisir le compte

Si vous appartenez à plusieurs comptes, choisissez-en un avec l'en-tête Pingerer-Account (l'identifiant du compte) ou un paramètre account_id. Sinon, c'est le compte du jeton qui est utilisé, puis votre premier compte d'équipe.

Ce que vous pouvez faire

  • Sites et surveillances : lister, ajouter, modifier, mettre en pause, relancer, tester maintenant, résultats, disponibilité. Cela inclut la date de renouvellement des domaines dont le registre la garde privée (renews_on).
  • Santé des sites : le score de santé de chaque site et ce qu'il faut corriger, et une nouvelle vérification immédiate.
  • Incidents : lister, prendre en charge, ajouter des notes, résoudre. Quand votre hébergeur est la cause probable, l'incident indique de quelle entreprise il s'agit.
  • Heartbeats, canaux d'alerte et heures calmes (avec votre week-end).
  • Fenêtres de maintenance, pages de statut et mises à jour (avec les adresses de leurs badges), et rapports mensuels.
  • Outils : l'aperçu de n'importe quelle page quand son lien est partagé, et la météo d'Internet (quels hébergeurs et CDN ont des problèmes en ce moment).
  • GET /api/v1/status pour savoir rapidement si tout est en ligne.

Les jetons des membres peuvent consulter et prendre en charge ; les modifications demandent le jeton d'un administrateur.

Webhooks

Pour recevoir les alertes dans votre propre code, ajoutez un canal d'alerte webhook. Chaque alerte est un POST JSON signé ; la page Alertes et canaux montre ce qu'il contient et comment vérifier la signature.

Réponses et erreurs

Les réponses sont en JSON, de la forme {"data": ..., "meta": ...}. Les erreurs sont {"error": "code", "message": "...", "details": ...}. Dépasser une limite du forfait renvoie 422 avec plan_limit ; un jeton en lecture seule qui essaie d'écrire reçoit 403 read_only_token.

Limites de débit

300 requêtes par minute et par jeton. Au-delà, vous recevez 429 : patientez un instant et réessayez.

Toujours bloqué ? Écrivez-nous, une vraie personne vous répondra.