Utilisation de l'interface VCOM API
Grâce à l'API VCOM, nos partenaires peuvent effectuer des recherches dans la base de données afin d'utiliser ces données pour des analyses ou d'autres systèmes. La gestion des tickets peut être traitée et évaluée par un système tiers (par exemple pour les parcs éoliens).
L'API VCOM est une interface de programmation, il est donc obligatoire d'avoir des connaissances en programmation pour pouvoir l'utiliser !
- Chaque partenaire ayant le niveau de service VCOM "Basic", "Pro" ou "Premium" reçoit une clé API. Cette clé API est nécessaire pour l'accès à la base de données.
- Si le nombre d'appels ou d'intervalles d'interrogation n'est pas suffisant, il est possible d'augmenter le nombre d'appels auprès de notre service commercial ( info-fr@meteocontrol.com).
-
Lien vers la documentation (en anglais) : https://meteocontrol.github.io/vcom-api/?shell#Cette documentation est destinée à aider les programmeurs de nos partenaires/clients VCOM.
Pour accés aux information sur l'API VCOM, se connecter au portail en administrateur et s'assurer d'être sur la page d'accueil 
, se rendre à "l'administration"
puis dans VCOM API
Cela garantit que le mot de passe ne peut pas être facilement intercepté et utilisé à d'autres fins. Le nom d'utilisateur et le mot de passe sont identiques à ceux de la connexion au compte VCOM.
Possible messages d'erreur "Errors" lors d'un appel et leur signification
400 Bad request. Possible reasons : - Malformed request parameters
- Missing request parameters
- Invalid json data provided
401 Unauthorized. Possible reasons: - Basic Authentication failed
- No API-key was provided
- An invalid API-Key was provided
403 Forbidden. Possible reasons: - User is not authorized to access the system
- User is not authorized to access the ticket
404 Endpoint not found. Possible reasons: - Route is not found
- Request an invalid device ID
- Request an invalid abbreviation ID
- Request an invalid comment ID
405 Method not allowed (See the returned Allowheader for the set of methods supported by the resource)429 Too Many Requests (Rate limit exceeded) 500 Unexpected Internal Error.
Our IT department has been notified and will look into this issue shortly - Try again later.
Sous "Endpoints" se trouvent les chaînes de caractères pour l'interrogation des données
Pour une installation, l'identifiant est utilisé pour l'interrogation des données, par exemple "ABCDE".
Il est aussi nécessaire d'avoir un compte utilisateur valide (nom d'utilisateur, mot de passe).
Le resultat de la requête de l'API VCOM est au format JSON. La meilleure façon de le tester est d'utiliser un plugin tel que "Postman" dans le navigateur Chrome. Il existe toute une série d'applications logicielles permettant de tester cela de manière approfondie.