Obtenir des sites

1. Introduction

Les informations sur le site constituent une partie importante du serveur MyQ Central. Avec le /sites votre application peut obtenir toutes les informations sur les sites disponibles qui sont configurés dans votre serveur central. Un exemple de cas d'utilisation est le filtrage et la connexion au bon serveur de site lorsqu'un client se déplace entre les réseaux en demandant un serveur de site basé sur la plage IP du réseau du client.

2. Les conditions préalables

Vous aurez besoin d'un serveur MyQ Central avec quelques sites déjà configurés et une application REST API dans MyQ → Paramètres → Systèmes externes. Aucun champ d'application n'est nécessaire.

3. Appeler l'API

Le point final est défini comme suit :

Endpoint:
GET /sites

Authentication:
Grant_type: client_credentials
Scopes: []

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Body: 
{}

Il convient de noter que le %access_token% doit être remplacé par le jeton que vous avez reçu en réponse à la commande point de terminaison d'authentification.

3.1. Filtrage des sites

Exemple de demande :

GET /sites?status=ok&client_ip=192.168.1.10-20&error=false

Trois paramètres GET permettent de filtrer les sites obtenus. L'appel au point final sans paramètre renvoie tous les sites présents sur le serveur central.

Les paramètres de filtrage disponibles sont les suivants :

• site - Statut du site, Valeurs disponibles : ok, unreachable, error

• client_ip - Filtrer les sites dont l'adresse donnée est définie dans ses plages.

• erreur - Filtrer les sites avec/sans erreur de réplication

4. Réponse

Le point de terminaison renvoie une liste de sites en fonction du filtre. Pour plus d'informations, voir Points d'extrémité de l'API du serveur central.