Passer au contenu principal
GET
/
v3
/
ping
Vérification de l'État du Service
curl --request GET \
  --url https://api.oneclickdz.com/v3/ping \
  --header 'X-Access-Token: <api-key>'
{
  "success": true,
  "data": {
    "api": "<string>",
    "operators": {
      "mobilis": "<string>",
      "ooredoo": "<string>",
      "djezzy": "<string>",
      "mobilisFixedPlans": "<string>"
    }
  },
  "meta": {
    "timestamp": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.oneclickdz.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Vue d’Ensemble

L’endpoint de vérification d’état vous permet de contrôler le statut du service API et de vérifier la disponibilité de chaque opérateur mobile.

​
Réponse

​
success
boolean
requis
Toujours true si l’API est opérationnelle
​
data
object
requis
​
meta
object

​
Exemple de Requête

curl --request GET \
  --url https://api.oneclickdz.com/v3/ping

​
Cas d’Utilisation

Surveillance du Service

Surveillez la disponibilité de l’API et le statut des opérateurs pour le suivi de disponibilité

Vérifications Préalables

Vérifiez que le service est opérationnel avant de traiter des transactions

Filtrage des Opérateurs

Masquez les opérateurs indisponibles dans votre interface utilisateur

Tableau de Bord d'État

Construisez un tableau de bord de statut pour votre équipe opérationnelle

​
Exemple d’Intégration

// Check service health before processing orders
async function canProcessOrders() {
  try {
    const response = await fetch("https://api.oneclickdz.com/v3/ping");
    const data = await response.json();

    if (data.data.api !== "ok") {
      console.error("API service is down");
      return false;
    }

    return true;
  } catch (error) {
    console.error("Health check failed:", error);
    return false;
  }
}

// Check specific operator availability
async function isOperatorAvailable(operator) {
  const response = await fetch("https://api.oneclickdz.com/v3/ping");
  const data = await response.json();

  const operatorMap = {
    Mobilis: "mobilis",
    Ooredoo: "ooredoo",
    Djezzy: "djezzy",
    Pixx: "mobilisFixedPlans",
  };

  const operatorKey = operatorMap[operator];
  return data.data.operators[operatorKey] === "up";
}

​
Bonnes Pratiques

Vérifiez l’endpoint de santé toutes les 30 à 60 secondes pour maintenir une vue à jour du statut du service.
setInterval(async () => {
  const response = await fetch('https://api.oneclickdz.com/v3/ping');
  const data = await response.json();
  updateServiceStatus(data.data);
}, 30000); // Check every 30 seconds
Mettez en cache le statut pendant 30 à 60 secondes pour éviter les requêtes excessives
let cachedStatus = null;
let lastCheck = 0;

async function getServiceStatus() {
  const now = Date.now();
  
  if (cachedStatus && (now - lastCheck) < 30000) {
    return cachedStatus;
  }
  
  const response = await fetch('https://api.oneclickdz.com/v3/ping');
  cachedStatus = await response.json();
  lastCheck = now;
  
  return cachedStatus;
}
Lorsqu’un opérateur est hors service, informez les utilisateurs et suggérez des alternatives
if (data.data.operators.djezzy === 'down') {
  showNotification('Djezzy service temporarily unavailable. Try Mobilis or Ooredoo.');
}