Vue d’ensemble
Les pages de statut publiques donnent une vue d’ensemble de la disponibilité et de la performance de votre site web. Elles peuvent être partagées largement, par exemple auprès de vos clients ou de vos partenaires, pour fournir des informations en temps réel sur la disponibilité et mettre en avant la transparence dans vos services web.
Exemples d’utilisation
L’API PublicStatusPage vous permet de :
- Gérer les pages de statut publiques : créez, modifiez et supprimez des pages de statut publiques.
- Configurer les pages de statut publiques : personnalisez votre page en choisissant le titre, la couleur de fond, les options de tri, etc.
- Consulter plusieurs pages de statut publiques simultanément : consultez l’état en temps réel et des informations détaillées pour plusieurs pages à la fois afin de faciliter l’analyse, le suivi et la création de rapports.
Prérequis
Pour utiliser l’API PublicStatusPage, vous avez besoin des éléments suivants :
Champs de l’API PublicStatusPage
L’API PublicStatusPage contient plusieurs champs :
| Nom du champ | Description |
|---|---|
PublicDashboardGuid |
Identifiant unique de la page de statut publique |
Name |
Nom de la page de statut publique |
IsPublished |
Indique true si la page de statut publique est publiée et accessible publiquement. Autrement, le champ indique false. |
PresetPeriodType |
Période applicable aux données. Les options de filtre suivantes sont disponibles : |
|
CustomizationInfo |
Contient différents champs permettant de modifier et de personnaliser votre page de statut publique. Pour en savoir plus, vous pouvez consulter la section sur les champs CustomizationInfo ci-dessous.
|
SlaGuid |
Identifiant unique du SLA. Si la page de statut publique contient des données basées sur un SLA, le SLA choisi sera utilisé. |
MonitorGuids |
Identifiant unique des moniteurs affichés sur la page de statut publique. |
MonitorGroupGuids |
Identifiant unique des groupes de moniteurs affichés sur la page de statut publique. |
Champs CustomizationInfo
Vous pouvez
personnaliser les paramètres d’affichage de votre page de statut publique au moyen des champs CustomizationInfo :
| Nom du champ CustomizationInfo | Description |
|---|---|
MainColor |
La valeur hexadécimale de la couleur utilisée pour le thème de votre page de statut publique. |
BackgroundColor |
La valeur hexadécimale de la couleur utilisée pour l’arrière-plan de votre page de statut publique. |
TextColor |
La valeur hexadécimale de la couleur utilisée pour le texte de votre page de statut publique. |
SortColumnsNewToOld |
Indique true si les colonnes sont triées de la plus à la moins récente. Autrement, le champ indique false. |
SortRowsProperty |
Définit les critères de tri des lignes. Les valeurs possibles sont Alphabétique (par nom de moniteur) ou Par statut (par statut de moniteur, les erreurs étant indiquées en premier). |
CommentTitle |
Le titre qui s’affiche dans la bannière de votre page de statut publique. |
CommentText |
Le message qui s’affiche dans la bannière pour informer les utilisateurs de l’état actuel ou des incidents en cours. |
AutoRefresh |
Indique true si la page de statut publique s’actualise et récupère automatiquement les données. Autrement, le champ indique false. |
Endpoints de l’API PublicStatusPage
L’API PublicStatusPage fournit les endpoints suivants pour gérer vos moniteurs :
Gestion des moniteurs
| Méthode | Endpoint | Description |
|---|---|---|
GET |
/PublicStatusPage |
Récupération d’une liste de toutes les pages de statut publiques de votre compte. |
POST |
/PublicStatusPage |
Création d’une nouvelle page de statut publique au moyen d’une configuration donnée. |
GET |
/PublicStatusPage/{publicStatusPageGuid} |
Récupération d’une page de statut publique spécifiée et de sa configuration |
PATCH |
/PublicStatusPage/{publicStatusPageGuid} |
Mise à jour de certains champs de la définition de la page de statut publique |
PUT |
/PublicStatusPage/{publicStatusPageGuid} |
Mise à jour de tous les champs de la définition de la page de statut publique |
DELETE |
/PublicStatusPage/{publicStatusPageGuid} |
Suppression de la page de statut publique spécifiée dans votre compte |
Pour en savoir plus sur les formats des requêtes et des réponses et la réalisation de tests interactifs, vous pouvez consulter la documentation de l’API PublicStatusPage d’Uptrends (en anglais).
Dépannage
Vous trouverez ci-dessous les erreurs HTTP les plus courantes et les étapes à suivre pour résoudre les problèmes liés à l’API PublicStatusPage.
Erreurs courantes
Codes de statut HTTP courants et leurs descriptions :
| Code de statut | Description |
|---|---|
| 200 | OK : requête réussie |
| 204 | Pas de contenu : la requête a été bien exécutée et aucune réponse n’a été envoyée. Ce code s’applique aux requêtes DELETE, PUT, PATCH et POST. |
| 400 | Mauvaise requête : les paramètres de requête sont invalides ou des champs obligatoires sont manquants. |
| 401 | Non autorisé : les identifiants d’authentification sont invalides ou manquants. |
| 403 | Interdit : autorisation refusée |
| 404 | Non trouvé : le GUID spécifié n’existe pas. |
| 500 | Erreur de serveur interne : une erreur s’est produite du côté serveur. |
Dépannage général
Pensez à :
- Toujours valider les données de votre requête avant d’envoyer les appels d’API.
- Utiliser des méthodes HTTP appropriées pour chaque opération.
Pour en savoir plus, veuillez contacter notre équipe de support.
Articles complémentaires
Pour en savoir plus, vous pouvez lire les articles suivants :
- Documentation de l’API PublicStatusPage d’Uptrends : cette documentation interactive vous fournit des spécifications détaillées sur les endpoints (en anglais).
- Journal de modification des API : cette page rassemble les dernières actualités sur l’API et les avis de retrait.