Utiliser l’interface Web de Django pour apporter des modifications à l’API

Familiarisez-vous avec l’interface Web de Django.

L’API de Juniper Mist repose sur une structure REST (Representational State Transfer) de Django. Cette architecture permet de parcourir les API, ce qui signifie que vous pouvez interagir avec les API directement à partir d’un navigateur Web. Cette API offre une convivialité et une flexibilité accrues en vous permettant, ainsi qu’à d’autres utilisateurs, d’effectuer des opérations CRUD au sein de l’API. Dans un sens, l’interface de Django agit comme un client RESTful. Cette fonction est pratique pour exécuter des opérations CRUD sur un seul objet API.

Pour apporter une modification à un objet de configuration, vous devez être connecté au portail Juniper Mist et connaître le chemin d’accès à l’API URL de l’objet. Consultez la documentation de l’API pour plus de détails et les paramètres de modification des objets. Vous trouverez les chemins d’API URL pour tous les objets disponibles.

Cette tâche vous explique comment obtenir des informations sur l’appareil à partir d’un point d’accès (AP) et renommer l’AP directement à partir de l’interface Django.

Pour utiliser l’interface Web de Django pour apporter des modifications à l’API :

Connectez-vous au portail Juniper Mist.
Ouvrez l’URL de l’API d’un appareil spécifique : https://<api-endpoint>/api/v1/sites/<site_id>/devices ?name=<nom de l’appareil>. Le nom de l’appareil est sensible à la casse.

Remarque :
Lorsque vous réutilisez des blocs de code, remplacez les valeurs d’espace réservé par des valeurs réelles, telles que votre jeton d’API, votre ID d’organisation, votre ID de site, votre nom d’AP, etc.
Dans ce cas, l’URL ressemblera à ceci (des parties de l’site_id sont omises) :

https://{api-host}/api/v1/sites/c1947558-268d-4d31-xxxx-xxxxxxxxxxxx/devices?name=TEST-rename

Le navigateur émet la commande suivante via l’interface de Django :
Juniper attribue Mist à chaque équipement un identifiant unique, généralement basé sur le adresse MAC (00000000-0000-1000-<device_mac>). Dans le contexte de l’API de l’appareil, il est appelé id. Vous devez référencer l’AP pour id que l’API sache quel appareil spécifique renommer.
Pour effectuer la modification, insérez l’ID de l’appareil (id) dans l’appel d’API et affichez-le dans le navigateur.
Le nouvel appel ressemblera à ceci :
https://{api-host}/api/v1/sites/c1947558-268d-4d31-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-5c5b3xxxxxxx
Le résultat est le même que celui de la requête précédente ; cependant, le contexte de l’API vous permet désormais d’apporter une modification à l’appareil spécifique en fonction du id et non du nom. Notez l’absence de crochets « [ ] ».
Saisissez le texte au format JSON (JavaScript Object Notation) dans la zone de saisie Contenu pour l’appel de renommage d’AP prévu. Vous n’avez pas besoin d’inclure l’ID d’appareil unique (id) car le id contexte existe dans l’URL.

Une fois terminée, appuyez sur PUT pour envoyer la demande à Juniper Mist. Les résultats devraient ressembler à ceci, indiquant que l’AP a été renommé :

Pour plus d’informations, consultez la section Site du site de documentation des API.

Utiliser l’interface Web de Django pour apporter des modifications à l’API

Documentation connexe