1.Informations nécessaires pour créer un endpoint
Comme décrit dans la documentation API, la commande POST API est utilisée pour créer un endpoint, nous avons besoins des informations suivantes :
- Nom du endpoint (nécessaire);
- Tags (optionnel) - vous avez la possibilité d'ajouter une information personnalisée pour chaque endpoint;
- Status : activé ou non (nécessaire) - si le endpoint doit être activé ou désactivé;
- Service profile (nécessaire) - l'identifiant du service profile assigné au endpoint. Pour trouver cette information, naviguez dans la section "Service Profile" dans l'Interface Utilisateur EMnify (EUI) ou éxecutez cet API;
- Tariff profile (nécessaire) - l'identifiant du tariff profile assigné à un endpoint. Pour trouver cette information, naviguez dans la section "Tariff Profile" dans l'EUI ou exécutez cet API;
- SIM (optionnel) - si nous voulons assigner directement une SIM à un endpoint, nous devrons entrer l'identifiant SIM (SIM ID) ici. Pour trouver cette information, naviguez dans la section "SIM" de l'EUI.
Pour chaque endpoint que nous souhaitons créer, les informations ci-dessus doivent être renseignées. Dans le but de créer plusieurs endpoint en une seule fois, nous pouvons utiliser l'option "Runner" dans Postman. Pour cela, créez un fichier .CSV (séparé avec des virgules) et entrez les informations comme ci-dessous :
sim_id | endpointname | tag | serviceprofile | tariffprofile |
233622 | JEtest1 | customerA | 129069 | 128197 |
333339 | JEtest2 | customerB | 121168 | 1299 |
Nous devons avoir autant de lignes dans le fichier que le nombre d'endpoint que nous souhaitons créer.
2. Préparer les API à exécuter
Pour exécuter l'ensemble de nos API, il faudra vous identifier (point 2.1) et par la suite exécuter l'API pour créer les endpoints (point 2.2).
2.1 Authentification
POST https://cdn.emnify.net/api/v1/authenticate
L'article concernant la méthode pour s'authentifier via les API est disponible ci-dessous.
2.2 Créer les endpoints en fonction des informations contenu dans le fichier .csv
POST https://cdn.emnify.net/api/v1/endpoint
Header :
Content-type: application/json
Authorization: Bearer {{auth_token}}
Body:
|
Les {{variables}} seront créée en fonction des informations contenues dans notre fichier .csv. Pour aller chercher les informations du fichier excel, nous utilisons l'option "Pre-request Script" disponible dans Postman.
Pre-request Script (dans Postman, cela est utilisé pour créer ces variables en fonction des information contenu dans le fichier .csv):
|
3. exécuter les différents API en une seule fois
Nous sommes maintenant prêt à exécuter automatiquement les API plusieurs fois et créer plusieurs endpoint en une fois. Dans Postman, cliquez sur "Runner", selectionnez une collection, un environnement et le fichier .csv. Le nombre d'itération devrait être automatiquement détecté. Vous pouvez prévisualiser votre fichier pour être sûr que tout est bien configuré avant de cliquer sur "start run". Le fichier devrait apparaître comme ci-dessous :
3.1 Réponses si les endpoints ont été créer avec succès
Authentication post API: 200 OK
Create endpoint post API: 201 Created
3.2 Réponses en cas de problème
- Le fichier .csv est délimité par des virgules (excel peut être un peu désordonné parfois, vous pouvez essayer un autre programme comme Notepad++) ;
- Vérifiez l'orthographe de vos variables : elles doivent être écrites exactement de la même manière dans le fichier .csv et dans Postman ;
- Vérifiez le format du corps de l'API dans lequel il est facile d'oublier un caractère.
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.