📃Format des réponses

Lorsque vous interagissez avec les API de Moneroo, il est essentiel de comprendre le format des réponses que vous recevrez. Cela vous aidera à interpréter correctement les réponses et à les traiter de manière appropriée dans votre application.


Structure de la réponse

Les réponses de l'API Moneroo sont renvoyées au format JSON et suivent une structure cohérente.

Voici un exemple de réponse typique :

{
  "success": true,
  "message": "Transaction initialized successfully.",
  "data": {}
}

Chaque partie de cette réponse contient des informations spécifiques :

  • success

Il s'agit d'un champ booléen qui indique si l'appel à l'API a abouti. Si la valeur est true, cela signifie que l'opération a réussi. S'il est false, cela signifie qu'il y a eu une erreur.

  • message

Il s’agit d’un champ de texte fournissant un message lisible par l’humain concernant le résultat de l’opération. Si le champ success est true, ce message donne généralement une confirmation de ce qui a été accompli. Si successest false, ce message fournit généralement des informations sur ce qui n’a pas fonctionné.

  • data

Il s'agit d'un objet qui contient toutes les données renvoyées par l'opération. La structure exacte de cet objet dépend du point de terminaison spécifique de l'API avec lequel vous interagissez et des informations qu'il est censé renvoyer. Par exemple, une requête liée à un paiement peut renvoyer des informations sur le paiement dans ce champ. S'il n'y a pas de données à renvoyer, ce champ sera un objet vide {}.

Veuillez vous référer à la documentation spécifique à chaque endpoint de l'API pour comprendre la structure et le contenu du champ de données pour chaque point de terminaison.

La compréhension de ce format de réponse est essentielle pour tirer le meilleur parti des API de Moneroo, car elle vous permettra de gérer les opérations réussies et les erreurs d'une manière robuste et conviviale.

Last updated