API publique WOOBAZ v1

Cette API permet a des services externes autorises de verifier certaines informations publiques WOOBAZ sans acceder aux donnees personnelles des proprietaires.

Telecharger OpenAPI JSON Telecharger collection Postman

Authentification

Les endpoints proteges utilisent une cle API transmise dans l un de ces en-tetes HTTP :

Authorization: Bearer wz_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

X-API-Key: wz_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Connexion utilisateur app

POST https://api.woobaz.com/v1/auth/login
Content-Type: application/json
X-API-Key: VOTRE_CLE_API

{
  "email": "utilisateur@example.com",
  "password": "mot-de-passe",
  "device_label": "WOOBAZ app"
}

La reponse contient un token de session utilisateur a transmettre ensuite avec X-User-Token.

GET https://api.woobaz.com/v1/auth/me
X-API-Key: VOTRE_CLE_API
X-User-Token: wz_user_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Verifier une immatriculation

POST https://api.woobaz.com/v1/registrations/verify
Content-Type: application/json
Authorization: Bearer VOTRE_CLE_API

{
  "registration": "1234567890ABCDEHNGRA"
}

Reponse type

{
  "ok": true,
  "exists": true,
  "registration": "1234567890ABCDEHNGRA",
  "asset": {
    "status": "active",
    "public_state": "registered",
    "category_id": 12,
    "brand_provided": true,
    "model_provided": true
  }
}

Lister les biens connectes

GET https://api.woobaz.com/v1/user/assets?limit=30
X-API-Key: VOTRE_CLE_API
X-User-Token: wz_user_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Cette route ne renvoie que les biens rattaches au compte utilisateur connecte.