OverviewGetting StartedAPI Reference

Démarrage

Soyez opérationnel avec PulseAPI en moins de 5 minutes.

1

S'inscrire

Créez votre compte sur ./signup.

Basique : 10 endpoints, vérifications toutes les minutes, alertes email + Telegram + Slack - 19 $/mois

2

Ajoutez votre premier endpoint

Après vous être connecté, vous verrez l'assistant d'intégration. Ajoutez votre premier endpoint :

  • Entrez l'URL de votre API (ex. : https://api.example.com/health)
  • Choisissez la méthode HTTP (GET, POST, etc.)
  • Définissez l'intervalle de vérification (1 à 60 minutes)
  • Configurez le délai d'expiration (5 à 60 secondes)
{
  "url": "https://api.example.com/health",
  "method": "GET",
  "checkInterval": 60,
  "timeout": 10
}
3

Configurer une page de statut

Créez une page de statut publique pour partager la disponibilité avec vos utilisateurs. Allez dans Dashboard > Page de statut.

  • Choisissez un slug unique pour votre URL
  • Personnalisez avec votre logo, vos couleurs et le nom de votre entreprise
  • Sélectionnez les endpoints à afficher
  • Ajoutez optionnellement un domaine personnalisé (ex. status.votreentreprise.com)

Votre page de statut sera disponible à status.pulseapi.com/your-slug

4

Configurer les alertes

PulseAPI envoie automatiquement des alertes pour :

Temps d'arrêt2 échecs consécutifs déclenchent une alerte
RécupérationEndpoint de retour en ligne après un temps d'arrêt
LentLe temps de réponse dépasse 2000ms (max 1 alerte/heure)

Toutes les alertes sont envoyées à votre email d'inscription. Configurez les webhooks et Telegram dans les Paramètres pour des canaux supplémentaires.

5

Tableau de bord de surveillance

Une fois votre endpoint ajouté, PulseAPI commence la surveillance immédiatement. Consultez :

  • Statut en temps réel (Opérationnel, Hors ligne, Dégradé)
  • Graphiques de temps de réponse (7 derniers jours)
  • Pourcentage de disponibilité (fenêtre glissante de 24h)
  • Tableau d'historique des vérifications (paginé, triable)
6

Utiliser l'API

Créez une clé API pour un accès programmatique à PulseAPI.

  1. Allez dans Dashboard > Paramètres > Clés API
  2. Cliquez sur Créer, nommez-la et sélectionnez les permissions (ex. endpoints:read, alerts:read)
  3. Copiez la clé immédiatement -- elle n'est affichée qu'une seule fois
# List your endpoints
curl -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints

# Trigger a manual check
curl -X POST -H "Authorization: pk_live_abc123..." \
  https://api.pulseapi.tech/endpoints/ENDPOINT_ID/check

Consultez la pour la liste complète des endpoints.Référence API

Étapes suivantes

Besoin d'aide ?

Des questions ou des commentaires ? Écrivez-nous à - nous répondons à chaque message.[email protected]