API allogarage

Les développeurs qui souhaiteraient interagir avec le site allogarage peuvent maintenant utiliser la nouvelle API!

URL d’accès: http://www.allogarage.fr/main/xmlrpc.php

5 fonctions simples sont accessibles via XMLRPC:

struct getGarage(int id)

permet de récupérer un garage a partir de son identifiant (id dans la base allogarage).

Exemple:

Paramètres d’appel:

<param>
<value><int>1345</int></value>
</param>

Retour:
<methodResponse>
<params>
<param>
<value><struct>
<member><name>id</name>
<value><string>1345</string></value>
</member>
<member><name>telephone</name>
<value><string>04 76 08 41 51</string></value>
</member>
<member><name>fax</name>
<value><string>04 76 08 57 20</string></value>
</member>
<member><name>email</name>
<value><string>info@ra.le-touvet.citroen.fr</string></value>
</member>
<member><name>name</name>
<value><string>GARAGE POULAT ANDRE</string></value>
</member>
<member><name>description</name>
<value><string></string></value>
</member>
<member><name>image</name>
<value><string></string></value>
</member>
<member><name>approved_manufacturer</name>
<value><array>
<data>
<value><struct>
<member><name>name</name>
<value><string>Citroën</string></value>
</member>
<member><name>image</name>
<value><string>images/logo_citroen.jpg</string></value>
</member>
<member><name>website</name>
<value><string>http://www.citroen.fr</string></value&gt;
</member>
</struct></value>
</data>
</array></value>
</member>
<member><name>car_maintenance_network</name>
<value><array>
<data>
</data>
</array></value>
</member>
<member><name>recommended_by</name>
<value><array>
<data>
</data>
</array></value>
</member>
<member><name>address</name>
<value><struct>
<member><name>garageId</name>
<value><string>1345</string></value>
</member>
<member><name>latitude</name>
<value><string>0.000000</string></value>
</member>
<member><name>longitude</name>
<value><string>0.000000</string></value>
</member>
<member><name>accuracy</name>
<value><string>0</string></value>
</member>
<member><name>CountryNameCode</name>
<value><string></string></value>
</member>
<member><name>AdministrativeAreaName</name>
<value><string></string></value>
</member>
<member><name>SubAdministrativeAreaName</name>
<value><string></string></value>
</member>
<member><name>LocalityName</name>
<value><string>LE TOUVET</string></value>
</member>
<member><name>DependentLocalityName</name>
<value><string></string></value>
</member>
<member><name>ThoroughfareName</name>
<value><string>RN 90 - -LES ALIQUETS</string></value>
</member>
<member><name>PostalCodeNumber</name>
<value><string>38660</string></value>
</member>
</struct></value>
</member>
<member><name>avis</name>
<value><string></string></value>
</member>
</struct></value>
</param>
</params>
</methodResponse>

struct search(int type,string query)

permet de trouver un garage a partir du nom, du code postal ou de la ville

Le type de recherche doit être 1 (recherche par ville), 2 code postal) ou 3 (nom du garage).

string setComment(int idGarage,string comment,int note,string IP)

permet d'ajouter un commentaire sur un garage. (L'IP correspond à l'IP du client qui veut déposer un commentaire, et pas au serveur qui fait l'appel à la méthode). La note est comprise entre 0 et 5.

struct localSearch(double nord,double sud,double est,double ouest)

permet de récupérer la liste des garages situés dans une zone géopgraphique bornée par les latitudes/longitudes passées en paramètres. Pour éviter les problèmes, la liste est limitée à 30 résultats, ordonnée par parroprt aux nombres d'avis déposés par garage.

exemple d'appel:

<param>
<value><double>53.80065082633023</double></value>
</param>
<param>
<value><double>39.57182223734374</double></value>
</param>
<param>
<value><double>42.53906</double></value>
</param>
<param>
<value><double>-36.5625</double></value>
</param>

struct geoSearch(double lat,double lng,double radius,int verbose)

permet de récupérer la liste des garages situés autour d'un point  (latitude/longitude passées en paramètres). Pour éviter les problèmes, la liste est limitée à 200 résultats, ordonnée par par rapport à la distance entre le garage et le point.

exemple d'appel:

<param>
<value><double>53.80065082633023</double></value>
</param>
<param>
<value><double>39.57182223734374</double></value>
</param>
<param>
<value><double>10</double></value>
</param>
<param>
<value><int>1</int></value>
</param>

advancedSearch(array params)

permet de trouver un garage a partir d'une partie du nom du garage, et du code postal.
premier argument : 2 (type de recherche)
deuxième argument : code postal (au moins deux caractères)
troisième argument : nom du garage

Pour information, la bibliothèque XMLRPC pour PHP a été utilisée. Vous pouvez la télécharger ici.

Pour éviter tout problème, une authentification (type Basic Authentication) a été ajoutée. Il suffit de me contacter pour avoir un login/password.

Debugger XMLRPC

Pour les développeurs PHP, vous pouvez utiliser le debugger pour tester votre code client, et même génerer le code client.

About these ads

Tags: , ,

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s


Suivre

Recevez les nouvelles publications par mail.