Introduction à l'API de l'animalerie

Ce document fournit une référence API pour un exemple de serveur de l'animalerie. Les requêtes trouvées ici peuvent aider les développeurs à faire des appels au serveur de l'animalerie pour envoyer ou demander des données sur les animaux de compagnie et les commandes entrées dans le système.

Avec l'API de l'animalerie, un développeur peut :

Animaux

• Créer, lire, mettre à jour et supprimer des animaux dans la base de données.
• Télécharger une image pour un animal.
• Trouver des animaux en fonction de leur statut (disponible, en attente, vendu), de leurs étiquettes ou de leurs identifiants uniques.

Magasin

• Obtenir l'inventaire des animaux de compagnie, classés par statut.
• Passer une commande pour un animal.
• Trouver les commandes par leur identifiant.
• Annuler une commande.

Utilisateur

• Créer un nouveau compte utilisateur (individuellement ou à partir d'une liste).
• Connecter les utilisateurs au système et les en dissocier.
• Trouver un utilisateur par son identifiant.
• Récupérer, mettre à jour et supprimer les informations d'un utilisateur à partir de son nom d'utilisateur.

Cet exemple utilise un chien (Krypto) et le numéro d'identification 210.

Conditions préalables à la connexion

L'URL de base de toutes les requêtes API est https://petstore3.swagger.io/api/v3.

Authentification

Pour authentifier votre connexion à l'API de l'animalerie, utilisez OAuth 2.0 ou une clé API attribuée. Pour demander une clé, envoyez un e-mail à budbaker@bhavenpets.com.

remarque

Pour des raisons de sécurité, ne partagez pas les clés API avec d'autres utilisateurs. Si vous soupçonnez une faille dans la sécurité de votre clé API, veuillez contacter immédiatement un administrateur afin qu'il révoque l'ancienne clé et en délivre une nouvelle.