Format de Réponse

Structure Standardisée

Tous les endpoints de l’API OneClickDz Flexy v3 suivent une structure de réponse cohérente, ce qui facilite la gestion des réponses dans votre application.

Réponse de Succès

Lorsqu’une requête réussit, la réponse suit cette structure :

{
  "success": true,
  "data": {
    // données spécifiques à l'endpoint
  },
  "meta": {
    "timestamp": "2025-10-29T00:00:00.000Z"
    // métadonnées supplémentaires (pagination, etc.)
  },
  "requestId": "req_1234567890_abc123"
}

Champs

boolean

requis

Toujours true pour les réponses de succès

object

requis

Contient le contenu de la réponse. La structure varie selon l’endpoint.

object

Métadonnées supplémentaires sur la réponse

Afficher properties

string

Horodatage ISO 8601 indiquant quand la réponse a été générée

object

Détails de pagination (pour les endpoints de liste)

string

Identifiant unique pour cette requête. Utilisez-le lors des contacts avec le support.

Réponse d’Erreur

Lorsqu’une requête échoue, la réponse suit cette structure :

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {
      // additional error context
    }
  },
  "requestId": "req_1234567890_abc123"
}

Champs

boolean

requis

Toujours false pour les réponses d’erreur

object

requis

Contient les informations d’erreur

Afficher properties

string

Code d’erreur lisible par la machine (ex. : NO_BALANCE, INVALID_PHONE)

string

Description de l’erreur lisible par l’humain

object

Contexte supplémentaire sur l’erreur (optionnel)

string

Identifiant unique pour cette requête. Incluez-le lors du signalement de problèmes.

Exemples de Réponse

Solde du Compte

{
  "success": true,
  "data": {
    "balance": 1326.13
  },
  "meta": {
    "timestamp": "2025-10-29T00:35:58.710Z"
  }
}

Envoi d’une Recharge Mobile

{
  "success": true,
  "data": {
    "topupId": "6901616fe9e88196b4eb64b0",
    "topupRef": "my-order-123",
    "newBalance": 826.13
  },
  "meta": {
    "timestamp": "2025-10-29T00:35:59.454Z"
  }
}

Liste des Transactions (avec Pagination)

{
  "success": true,
  "data": {
    "items": [
      {
        "type": "FLEXY",
        "amount": 500,
        "time": "2025-10-29T00:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "totalPages": 10,
      "totalResults": 195
    }
  },
  "meta": {
    "timestamp": "2025-10-29T00:35:58.852Z"
  }
}

Pagination

Les endpoints de liste incluent la pagination dans la réponse :

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "totalPages": 10,
      "totalResults": 195
    }
  }
}

Champs de Pagination

integer

Numéro de page actuel (indexé à partir de 1)

integer

Nombre d’éléments par page

integer

Nombre total de pages disponibles

integer

Nombre total d’éléments sur toutes les pages

Paramètres de Requête pour la Pagination

Contrôlez la pagination à l’aide de ces paramètres de requête :

Paramètre	Type	Défaut	Description
`page`	integer	1	Numéro de page (minimum : 1)
`pageSize`	integer	20	Éléments par page (min : 1, max : 100)

Vérifiez toujours totalPages pour savoir quand arrêter la pagination.

Codes de Statut HTTP

L’API utilise les codes de statut HTTP conventionnels :

Code de Statut	Signification
`200`	Succès - Requête complétée avec succès
`400`	Requête Incorrecte - Paramètres invalides ou erreur de validation
`401`	Non Autorisé - Clé API invalide ou manquante
`403`	Interdit - Solde ou permissions insuffisants
`404`	Non Trouvé - La ressource n’existe pas
`429`	Trop de Requêtes - Limite de taux dépassée
`500`	Erreur Interne du Serveur - Un problème est survenu de notre côté
`503`	Service Indisponible - Interruption temporaire du service

Même pour les codes de statut non-200, la réponse suit le format d’erreur standard.

ID de Requête

Chaque réponse inclut un requestId unique :

{
  "success": true,
  "data": {...},
  "requestId": "req_1761698159_abc123xyz"
}

Utilisations du Request ID

Débogage

Suivre les requêtes dans les journaux et identifier les problèmes

Support

Inclure dans les tickets de support pour une résolution plus rapide

Audit

Corréler les requêtes avec les transactions

Surveillance

Suivre le flux des requêtes entre les systèmes

Enregistrez toujours le requestId pour chaque appel API que vous effectuez. Il est indispensable pour le débogage.

Type de Contenu

Toutes les requêtes et réponses utilisent JSON :

En-têtes de Requête

Content-Type: application/json
X-Access-Token: YOUR_API_KEY

En-têtes de Réponse

Content-Type: application/json; charset=utf-8
X-Request-ID: req_1761698159_abc123xyz
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 115
X-RateLimit-Reset: 1761698219

Traitement des Réponses

Bonnes Pratiques

Vérifier toujours le champ success

const response = await fetch(url, options);
const data = await response.json();

if (data.success) {
  console.log(data.data);
} else {
  console.error(data.error.code, data.error.message);
}

Enregistrer les Request IDs

console.log(`Request ${data.requestId}: ${data.success ? 'Success' : 'Failed'}`);

if (!data.success) {
  console.error(`Error ${data.error.code}: ${data.error.message}`);
}

Gérer la pagination

let page = 1;
let allItems = [];

while (true) {
  const response = await fetch(`${url}?page=${page}&pageSize=100`);
  const data = await response.json();
  
  if (!data.success) break;
  
  allItems.push(...data.data.items);
  
  if (page >= data.data.pagination.totalPages) break;
  page++;
}

Analyser les timestamps

const timestamp = new Date(data.meta.timestamp);
console.log(`Response generated at: ${timestamp.toLocaleString()}`);

Référence API

Core

Compte

Recharges mobiles

Recharges internet

Cartes cadeaux

Navio

Structure Standardisée

Réponse de Succès

Champs

Réponse d’Erreur

Champs

Exemples de Réponse

Solde du Compte

Envoi d’une Recharge Mobile

Codes de Statut HTTP

ID de Requête

Utilisations du Request ID

Débogage

Support

Audit

Surveillance

Type de Contenu

En-têtes de Requête

En-têtes de Réponse

Traitement des Réponses

Bonnes Pratiques

Étapes suivantes

Gestion des erreurs

Endpoints principaux

​Structure Standardisée

​Réponse de Succès

​Champs

​Réponse d’Erreur

​Champs

​Exemples de Réponse

​Solde du Compte

​Envoi d’une Recharge Mobile

​Liste des Transactions (avec Pagination)

​Pagination

​Champs de Pagination

​Paramètres de Requête pour la Pagination

​Codes de Statut HTTP

​ID de Requête

​Utilisations du Request ID

Débogage

Support

Audit

Surveillance

​Type de Contenu

​En-têtes de Requête

​En-têtes de Réponse

​Traitement des Réponses

​Bonnes Pratiques

​Étapes suivantes

Gestion des erreurs

Endpoints principaux

Structure Standardisée

Réponse de Succès

Champs

Réponse d’Erreur

Champs

Exemples de Réponse

Solde du Compte

Envoi d’une Recharge Mobile

Liste des Transactions (avec Pagination)

Pagination

Champs de Pagination

Paramètres de Requête pour la Pagination

Codes de Statut HTTP

ID de Requête

Utilisations du Request ID

Type de Contenu

En-têtes de Requête

En-têtes de Réponse

Traitement des Réponses

Bonnes Pratiques

Étapes suivantes