Documentation API
Integrez Error Explorer dans vos applications
API REST complete pour envoyer, recuperer et gerer vos erreurs programmatiquement.
Exemple API
# Envoyer une erreur a Error Explorer
curl -X POST https://api.error-explorer.com/webhook
-H "Authorization: Bearer YOUR_API_KEY"
-H "Content-Type: application/json"
-d '{"message": "Error occurred"}'
# Pret a tracker les erreurs !
Introduction à l'API
L'API Error Explorer vous permet d'accéder programmatiquement à vos données d'erreurs, de gérer vos projets et d'obtenir des statistiques détaillées pour intégrer le monitoring d'erreurs dans vos workflows existants.
Format des réponses
Toutes les réponses sont au format JSON avec les codes de statut HTTP appropriés.
response.json
{
"success" : true ,
"data" : { ... },
"timestamp" : "2025-09-29T14:30:25+00:00"
}
Authentification
Toutes les requêtes API nécessitent une authentification via une clé API. Votre clé API doit être incluse dans l'en-tête Authorization de chaque requête.
Inscription requise
Créez un compte gratuit pour générer une clé API et accéder à toutes les fonctionnalités.
Créer un compteUtilisation de la clé API
Incluez votre clé API dans l'en-tête de toutes vos requêtes :
headers
Authorization: Bearer YOUR_API_KEY
headers
X-API-Key: YOUR_API_KEY
Limitation du taux
L'API Error Explorer applique des limites de taux pour assurer la stabilité du service.
Limites actuelles
Plan Gratuit : 1000 requêtes/heure
En-têtes de limite
Chaque réponse inclut des en-têtes indiquant votre utilisation actuelle :
headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1693574400
Gestion de projets
Gérez vos projets Error Explorer.
Récupère la liste de vos projets.
Paramètres de requête
page
integer
optionnel
Numéro de page (défaut: 1)
limit
integer
optionnel
Nombre de résultats par page (défaut: 20, max: 100)
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/projects?page=1&limit=20" \
-H "Authorization: Bearer YOUR_API_KEY"
Réponse (200 OK)
response.json
{
"success" : true ,
"data" : [
{
"id" : 1 ,
"name" : "Mon Application" ,
"environment" : "production" ,
"error_count" : 142 ,
"created_at" : "2025-01-15T10:30:00Z"
}
],
"pagination" : {
"page" : 1 ,
"limit" : 20 ,
"total" : 3
}
}
Crée un nouveau projet
Corps de la requête
name
string
requis
Nom du projet (max 255 caractères)
description
string
optionnel
Description du projet
environment
string
requis
Environnement (prod, staging, dev, test)
notification_email
string
optionnel
Email pour les notifications
Exemple de requête
curl
curl -X POST "https://error-explorer.com/api/v2/projects" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Mon Application Web",
"description": "Application de gestion",
"environment": "prod",
"notification_email": "admin@example.com"
}'
Met à jour un projet existant
Paramètres d'URL
id
integer
requis
ID du projet à mettre à jour
Corps de la requête
name
string
optionnel
Nouveau nom du projet
description
string
optionnel
Nouvelle description du projet
environment
string
optionnel
Environnement (dev, staging, prod)
Exemple de requête
curl
curl -X PUT "https://error-explorer.com/api/v2/projects/1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Mon Application Mise à Jour",
"description": "Description mise à jour"
}'
Réponse (200 OK)
response.json
{
"success" : true ,
"message" : "Projet mis à jour avec succès" ,
"data" : {
"id" : 1 ,
"name" : "Mon Application Mise à Jour" ,
"updated_at" : "2025-01-15T11:30:00Z"
}
}
Supprime définitivement un projet et toutes ses données
Paramètres d'URL
id
integer
requis
ID du projet à supprimer
En-têtes requis
X-Confirm-Delete
string
requis
Doit être "true" pour confirmer la suppression
Exemple de requête
curl
curl -X DELETE "https://error-explorer.com/api/v2/projects/1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-Confirm-Delete: true"
Réponse (200 OK)
response.json
{
"success" : true ,
"message" : "Projet supprimé avec succès"
}
⚠️ Attention
La suppression d'un projet est irréversible. Toutes les erreurs, statistiques et données associées seront définitivement supprimées.
Gestion des erreurs
Endpoints pour récupérer, mettre à jour et gérer les erreurs de vos projets.
Récupère la liste des erreurs d'un projet
Paramètres d'URL
id
integer
requis
ID du projet
Paramètres de requête
page
integer
optionnel
Numéro de page (défaut: 1)
limit
integer
optionnel
Nombre de résultats par page (défaut: 20, max: 100)
status
string
optionnel
Filtrer par statut : new, resolved, ignored
severity
string
optionnel
Filtrer par sévérité : low, medium, high, critical
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/projects/1/errors?status=new&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Réponse (200 OK)
response.json
{
"success" : true ,
"data" : [
{
"id" : 123 ,
"message" : "Database connection failed" ,
"status" : "new" ,
"severity" : "high" ,
"occurrences" : 42 ,
"first_seen" : "2025-01-15T10:30:00Z" ,
"last_seen" : "2025-01-15T12:15:00Z"
}
],
"pagination" : {
"page" : 1 ,
"limit" : 10 ,
"total" : 142
}
}
Récupère les détails complets d'une erreur spécifique
Paramètres d'URL
id
integer
requis
ID de l'erreur
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/errors/123" \
-H "Authorization: Bearer YOUR_API_KEY"
Met à jour le statut ou les propriétés d'une erreur
Paramètres d'URL
id
integer
requis
ID de l'erreur à mettre à jour
Corps de la requête
status
string
optionnel
Nouveau statut : new, resolved, ignored
assignee_id
integer
optionnel
ID de l'utilisateur assigné
tags
array
optionnel
Liste de tags à assigner
Exemple de requête
curl
curl -X PATCH "https://error-explorer.com/api/v2/errors/123" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "resolved",
"tags": ["bug", "database"]
}'
Analytics & Statistiques
Récupérez des statistiques détaillées et des métriques sur vos erreurs pour analyser les tendances et améliorer la qualité de vos applications.
Récupère les statistiques de base pour tous vos projets
Paramètres de requête
period
string
optionnel
Période : 7d, 30d, 90d (défaut: 7d)
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/analytics/basic?period=30d" \
-H "Authorization: Bearer YOUR_API_KEY"
Réponse (200 OK)
response.json
{
"success" : true ,
"data" : {
"total_errors" : 2547 ,
"affected_users" : 342 ,
"error_rate" : "0.23%" ,
"trend" : "-15%" ,
"top_errors" : [
{
"message" : "Database connection failed" ,
"count" : 523 ,
"impact" : "high"
}
]
}
}
Récupère les statistiques détaillées pour un projet spécifique
Paramètres d'URL
id
integer
requis
ID du projet
Paramètres de requête
period
string
optionnel
Période : 24h, 7d, 30d, 90d (défaut: 7d)
group_by
string
optionnel
Grouper par : hour, day, week (défaut: day)
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/projects/1/analytics?period=7d&group_by=day" \
-H "Authorization: Bearer YOUR_API_KEY"
Webhooks
Les webhooks permettent à vos applications d'envoyer automatiquement les erreurs à Error Explorer dès qu'elles se produisent.
Endpoint principal pour recevoir les erreurs de vos applications
Paramètres d'URL
token
string
requis
Token unique de votre projet
Corps de la requête
message
string
requis
Message d'erreur
level
string
optionnel
Niveau : error, warning, info (défaut: error)
exception
object
optionnel
Détails de l'exception (type, stacktrace)
context
object
optionnel
Contexte de l'erreur (user, request, server)
breadcrumbs
array
optionnel
Historique des actions avant l'erreur
Exemple de requête
curl
curl -X POST "https://error-explorer.com/webhook/error/YOUR_PROJECT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"message": "Database connection failed",
"level": "error",
"exception": {
"type": "PDOException",
"stacktrace": "..."
},
"context": {
"user": {"id": 123, "email": "user@example.com"},
"request": {"url": "/api/users", "method": "GET"}
}
}'
Réponse (200 OK)
response.json
{
"success" : true ,
"error_id" : "err_abc123xyz" ,
"fingerprint" : "d4f6g8h9"
}
Vérifie la connectivité et la validité de votre token
Paramètres d'URL
token
string
requis
Token unique de votre projet
Exemple de requête
curl
curl -X GET "https://error-explorer.com/webhook/ping/YOUR_PROJECT_TOKEN"
Réponse (200 OK)
response.json
{
"success" : true ,
"message" : "Webhook endpoint is active" ,
"project" : "Mon Application"
}
Statut Système
Vérifiez la santé et la disponibilité des services Error Explorer en temps réel.
Récupère le statut complet du système
ℹ️ Note
Cet endpoint ne nécessite pas d'authentification et peut être utilisé pour le monitoring externe.
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/system-status"
Réponse (200 OK)
response.json
{
"status" : "operational" ,
"timestamp" : "2025-01-15T14:30:00Z" ,
"services" : {
"api" : "operational" ,
"database" : "operational" ,
"cache" : "operational" ,
"queue" : "operational"
},
"metrics" : {
"response_time_ms" : 45 ,
"uptime_percentage" : 99.98
}
}
Version simplifiée pour le polling fréquent
Exemple de requête
curl
curl -X GET "https://error-explorer.com/api/v2/system-status/basic"
Réponse (200 OK)
response.json
{
"status" : "operational" ,
"timestamp" : "2025-01-15T14:30:00Z"
}
Codes d'erreur
L'API utilise des codes de statut HTTP standards et retourne des messages d'erreur détaillés en JSON.
Format des erreurs
error.json
{
"success" : false ,
"error" : {
"code" : "INVALID_PARAMETERS" ,
"message" : "Le nom du projet est requis" ,
"details" : {
"field" : "name"
}
}
}