Format de Réponse - Raba7ni Developer API

Réponse de Succès

Lorsqu'une requête réussit, vous recevez une réponse avec success: true :

Structure de Réponse de Succès

{
  "success": true,
  "data": {
    // Les données de réponse varient selon le point de terminaison
  },
  "message": "Message de succès optionnel",
  "meta": {
    "mode": "test",
    "request_id": "req_abc123def456"
  }
}

Champ	Type	Description
`success`	booléen	Toujours `true` pour les requêtes réussies
`data`	objet	La charge utile de la réponse (varie selon le point de terminaison)
`message`	chaîne	Message de succès lisible par l'homme optionnel
`meta`	objet	Métadonnées incluant le mode et l'ID de requête

Réponse d'Erreur

Lorsqu'une requête échoue, vous recevez une réponse avec success: false :

Structure de Réponse d'Erreur

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Le champ phone_number est requis.",
    "details": {
      "phone_number": ["Le champ phone_number est requis."]
    }
  },
  "meta": {
    "mode": "test",
    "request_id": "req_xyz789"
  }
}

Codes d'Erreur Courants

Statut HTTP	Code d'Erreur	Description
400	`VALIDATION_ERROR`	La validation du corps de la requête a échoué
401	`UNAUTHORIZED`	Identifiants API manquants ou invalides
403	`FORBIDDEN`	La clé API n'a pas la portée requise
404	`NOT_FOUND`	Ressource demandée non trouvée
409	`CONFLICT`	La ressource existe déjà ou conflit d'état
429	`RATE_LIMITED`	Trop de requêtes, ralentissez
500	`INTERNAL_ERROR`	Erreur serveur, contactez le support

Gestion des Erreurs

Vérifiez le champ success

Vérifiez toujours success avant de traiter les données de la réponse.

Exemple JavaScript

const response = await fetch('/api/v1/developer/...');
const data = await response.json();

if (!data.success) {
  console.error('Erreur :', data.error.message);
  return;
}

// Traiter data.data

Gérez les Codes d'Erreur Spécifiques

Différents codes d'erreur peuvent nécessiter différentes stratégies de gestion.

Loguez l'ID de Requête

Incluez meta.request_id lorsque vous contactez le support - cela nous aide à déboguer les problèmes rapidement.

Pagination

Les points de terminaison de liste renvoient des résultats paginés :

Réponse Paginée

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 150,
      "total_pages": 8
    }
  }
}

Utilisez des paramètres de requête pour naviguer dans les pages :

?page=2 - Demander une page spécifique
?per_page=50 - Changer le nombre d'éléments par page (max 100)