Utilisation

  • L'URL de l'interface REST est http://neufbox/api/1.0/1.0 est le numéro de version de l'interface.
  • L'interface peut être testée avec wget ou curl par exemple.
  • L'interface doit être appelée avec une requête HTTP GET pour les méthodes qui ne font que consulter des informations, et une requête HTTP POST pour les méthodes qui modifient des informations.
  • Certaines méthodes sont privées. Il est alors nécessaire d'être authentifié pour en avoir l'accès. L'authentification se fait grâce au module auth.

exemple d'appel d'une méthode:

curl http://neufbox/api/1.0/?method=auth.getToken

Message de retour

  • Lorsque l'appel de la méthode a réussi, l'attribut stat de la balise rsp vaut ok

exemple:

<?xml version="1.0" ?>
<rsp stat="ok" version="1.0">
	[resultat]
</rsp>
  • Si l'appel de la méthode a échoué, l'attribut stat de la balise rsp vaut fail. La balise rsp contient alors une balise err avec un attribut code contenant le code d'erreur et un attribut msg contenant un message d'explication de l'erreur en anglais.

exemple:

<?xml version="1.0" ?>
<rsp stat="fail" version="1.0">
	<err code="[code-erreur]" msg="[message-erreur]" />
</rsp>

Code d'erreur

Il existe 2 types de code d'erreur:

  • les codes d'erreurs "généraux" qui peuvent être renvoyés suite à n'importe quel appel
  • les codes d'erreurs propres à la méthode appelée

Code d'erreur généraux

code msg explication
0 Unknown error Une erreur inconnue s'est produite
112 Method not found Impossible de trouver la méthode demandée
113 Need argument(s) Besoin de plus d'arguments
114 Invalid argument(s) Arguments soumis invalides
115 Need authentication Authentification nécessaire
120 The box being upgrade La neufbox est en cours de mise à jour

Sections

Les méthodes sont organisées en différentes sections.