Chargement…

Aller au contenu principal

Documentation API

Points d’intégration et bonnes pratiques.

Introduction

L'API REST Vetzy permet d'intégrer la recherche vétérinaire, les profils professionnels et la gestion des rendez-vous dans vos applications tierces. Elle est conçue pour les partenaires, intégrateurs et éditeurs de logiciels vétérinaires.

La spécification OpenAPI est la source de vérité pour les schémas, paramètres et codes de réponse. Consultez-la avant toute mise en production.

Authentification

L'API utilise des jetons d'accès (Bearer token) émis via Laravel Sanctum. Chaque requête authentifiée doit inclure l'en-tête :

Authorization: Bearer <your-token>

Les jetons sont liés à un compte API et à un ensemble de permissions (scopes). Ne partagez jamais vos jetons dans le code client public ni dans un dépôt versionné.

Obtenir un accès

Les comptes API ne sont pas créés via une inscription publique. Pour obtenir un accès :

  1. Contactez Vetzy via le centre de support en précisant votre cas d'usage (intégration, volume estimé, environnements).
  2. Un administrateur Vetzy provisionne votre compte et les clés associées.
  3. Demandez une clé avec la permission docs pour accéder à la documentation interactive Swagger.

Documentation interactive : https://api.vetzy.eu/api/docs

URL de base

Toutes les requêtes utilisent le versionnement explicite dans le chemin :

https://api.vetzy.eu/v1/

Utilisez toujours HTTPS en production. Les en-têtes recommandés :

Accept: application/json
Content-Type: application/json

Endpoints principaux

Les ressources exposées incluent notamment :

  • Utilisateurs et profils — consultation et mise à jour selon vos permissions
  • Animaux — fiches liées aux propriétaires
  • Vétérinaires et centres — recherche et profils publics
  • Rendez-vous — création, consultation et annulation
  • Services — types de consultation et disponibilités

Référez-vous à la spec OpenAPI pour la liste complète, les paramètres de pagination et les filtres disponibles.

Limites et quotas

Un rate limiting est appliqué sur les routes publiques et authentifiées. En cas de dépassement, l'API renvoie 429 Too Many Requests avec un en-tête Retry-After.

Bonnes pratiques côté client :

  1. Mettre en cache les réponses de lecture lorsque c'est pertinent
  2. Implémenter un backoff exponentiel sur les erreurs 429 et 5xx
  3. Éviter le polling agressif ; privilégier les webhooks lorsqu'ils sont disponibles

Bonnes pratiques

  1. Versionnez vos intégrations sur /v1/ — anticipez les évolutions en consultant le changelog API
  2. Validez toutes les entrées côté client et serveur
  3. Stockez les jetons de façon sécurisée (variables d'environnement, coffre-fort)
  4. Journalisez les identifiants de corrélation pour faciliter le support
  5. Testez d'abord en environnement de développement avant le déploiement production

Questions d'intégration : centre de support Vetzy.