Vérification de l'État du Service

Vérifier l’état du service API et la disponibilité des opérateurs

GET /v3/ping

Vérification de l'État du Service

cURL

curl --request GET \
  --url https://api.oneclickdz.com/v3/ping \
  --header 'X-Access-Token: <api-key>'

200

{
  "success": true,
  "data": {
    "api": "<string>",
    "operators": {
      "mobilis": "<string>",
      "ooredoo": "<string>",
      "djezzy": "<string>",
      "mobilisFixedPlans": "<string>"
    }
  },
  "meta": {
    "timestamp": "<string>"
  }
}

​

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

Afficher properties

api · string

Statut du service : "ok" ou "error"

operators · object

Statut de chaque opérateur

Afficher properties

mobilis · string

Statut de l’opérateur Mobilis : "up" ou "down"

ooredoo · string

Statut de l’opérateur Ooredoo : "up" ou "down"

djezzy · string

Statut de l’opérateur Djezzy : "up" ou "down"

mobilisFixedPlans · string

Statut des forfaits fixes Mobilis (Sama | Pixx) : "up" ou "down"

meta · object

Afficher properties

timestamp · string

Horodatage actuel du serveur (format ISO 8601)

​

Exemple de Requête

cURL

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

Interroger Périodiquement

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

Mettre en Cache le Statut

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;
}

Gérer l'État Dégradé

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.');
}