Le système VMware Edge Network Intelligence dispose d'une API en lecture seule qui permet d'accéder à une grande partie des données via une interface de programmation. Cette intégration permet aux organisations d'intégrer des données VMware Edge Network Intelligence à d'autres systèmes externes, tels que des entrepôts de données ou des solutions d'informatique décisionnelle.

L'API VMware Edge Network Intelligence est une API en lecture seule basée sur le graphique QL. Si vous n'êtes pas habitué à GraphQL, nous vous encourageons à consulter le guide GraphQL pour obtenir de plus amples informations sur l'infrastructure. L'un des avantages distincts de Graph QL, par rapport à d'autres interfaces d'API, est que, contrairement à REST, il permet l'extraction d'appels uniques de données filtrées.

Éléments de données actuellement pris en charge

Client

Attributs, historique, performances

Application

Utilisation, débit

Point d'accès

Attributs, performances

Groupes personnalisés

performances

Recommandations

détails

Conseils mondiaux

détails

Sécurité de l'Internet des objets (IoT)

Analyse du comportement d'un périphérique/groupe unique

Incidents

détails

Exploration interactive de l'API

Dans VMware Edge Network Intelligence, vous pouvez explorer l'API via une interface graphique interactive. Pour accéder à l'interface utilisateur graphique de l'API, vous devez vous authentifier sur l'application VMware Edge Network Intelligence, puis vous pouvez accéder à : https://<your-ENI-URL>/API/v2/graphiql

Limite du débit de l'API

Le serveur d'API de VMware Edge Network Intelligence sur le cloud public peut traiter 2 demandes par seconde. Il est possible d'envoyer et de mettre en file d'attente jusqu'à 60 demandes simultanément ; ces dernières seront traitées au rythme de 2 demandes par seconde. Si plus de 60 demandes sont reçues en même temps, les demandes qui suivent les 60 premières sont renvoyées avec un code d'erreur 429 : « vous avez atteint la limite de demande d'API » (You have hit the API request limit). Les demandes d'API sur le dispositif de cloud privé ne sont PAS limitées par le débit.

Génération d'un jeton d'API

Pour générer un jeton d'API, accédez à vos préférences d'utilisateur et choisissez API de développeur (Developer API).

À partir de là, vous pouvez générer un jeton qui peut être utilisé pour s'authentifier auprès de l'API.
Figure 1. Génération d'un jeton d'API

Documentation GitHub

Pour plus d'informations sur l'API, reportez-vous à notre référentiel GitHub

Exemples d'API

Liste des clients compatibles 5 GHz se connectant sur 2,4 GHz au cours des 2 dernières semaines à un emplacement spécifique

Exemple de requête

query{
 deviceList(filters:{
    op:AND,
     filters:[
      {field:"rfBand", value:"2"},
        {field:"is5ghzCapable", value:"true"}
     ]
}){
totalCount
devices {
hostname
macAddr
is5ghzCapable
rfBand
userName
isIotDevice
apDwellTimeMs
createdAt
deviceTypeDetails {
model
osAndVersion
deviceClass
}
}
}
}
Figure 2. Exemple de réponse