Woosmap Data API : développement backend désormais ouvert

Sommaire
Image

La Woosmap Data API permet de développer des sites et applications pour interroger et afficher de manière programmatique les résultats issus de vos données de points de vente. Grâce à cette API, des requêtes RESTful côté backend renvoient les résultats de recherche Woosmap au format JSON. Un usage classique, illustré par le schéma ci-dessus, consiste à récupérer les points de vente proches d’un internaute connu, puis à interroger un service qui retourne la disponibilité produit pour chacun d’entre eux.

Comment l’utiliser

La documentation développeurs Woosmap regroupe toutes les informations nécessaires pour exploiter ce service. L’API accepte deux familles de paramètres :

  • Paramètres géographiques : autour d’un point géographique via lat, lng (que vous pouvez obtenir avec notre Geolocation API pour localiser l’utilisateur) et un paramètre max_distance, ou le long d’une polyligne via encoded_polyline et un paramètre radius
  • Paramètres d’attributs : à partir des attributs des points de vente idstore, name, city, type (par exemple pour ne retenir que les magasins disposant du click & collect) et tag.

Exemple de requête en Python

L’exemple suivant retourne les points de vente situés à moins de 50 km

(max_distance = 50000) 

d’un utilisateur localisé à Bruxelles, en Belgique

(user_position = {'lat': 50.840, 'lng': 4.348})
import requests
private_key = 'z6a4f926-58c3-41a8-4b2b-24ee682fef01'  # your private key here
endpoint_api = 'https://api.woosmap.com/stores/search'
user_position = {'lat': 50.840, 'lng': 4.348}  # a given user position
max_distance = 50000  # value in meters
session = requests.Session()
response = session.get(endpoint_api,
params={'private_key': private_key,
'lat': user_position['lat'],
'lng': user_position['lng'],
'max_distance': max_distance})
response.json()

Pourquoi réserver cette API au backend ?

Cette API RESTful est uniquement destinée au développement côté backend, car chaque requête doit inclure votre paramètre private_key. Cette clé doit rester privée : elle donne accès à la gestion complète de vos données de points de vente. Vous évitez ainsi tout usage malveillant du service, par exemple la suppression de l’ensemble de vos données par un développeur mal intentionné.