Clients API prêts à l’emploi et génération du modèle de données

Last modified: 27. juin 2022

Modèle de données à partir de XML Schema (XSD)

Le modèle de données sous forme de schéma XML (fichier XSD) pour les formats de données ITscope peut être récupéré via l’API interactive en utilisant la méthode API « info« . Aucune clé API n’est nécessaire pour cette récupération. Le format de sortie des données est simplement défini comme le chemin d’accès URL.

URL vers la définition du schéma pour le format de sortie des données « standard » :

https://api.itscope.com/2.1/info/schema/standard.xsd


URL vers la définition du schéma pour le format de sortie des données « standardUpdate » :

https://api.itscope.com/2.1/info/schema/standardupdate.xsd


URL vers la définition du schéma pour le format de sortie des données « developer » :

https://api.itscope.com/2.1/info/schema/developer.xsd


URL vers la définition du schéma pour le format de sortie des données « developerUpdate » :

https://api.itscope.com/2.1/info/schema/developerupdate.xsd


Instructions pour Java

Le résultat de l’appel API pour le schéma dépend du format de données, c’est-à-dire que la définition XML peut ensuite être enregistrée localement sur le disque dur, par exemple sous c:\temp\itscope_api.xsd

En utilisant le Binding Compiler pour Java (xjc.exe), un modèle de classe Java peut maintenant être créé sur la base de la définition XML.

 
Cet appel crée un paquet portant le nom de.itscope.api.

« c:\Program Files\Java\jdk1.7.0_51\bin\xjc.exe » -p de.itscope.api c:\temp\itscope_api.xml

Tutoriel pour C#, .NET et VB.NET

Il ne s’agit que d’exemples d’outils ou de tutoriels sur la génération de schémas.

Client Swagger API pour différents langages de développement

Les clients API peuvent être créés en utilisant le cadre public Swagger (voir http://www.swagger.io) utilisé par ITscope pour créer le modèle de données API et la documentation API. Ces clients sont destinés à servir de cadre à une demande, ce qui devrait permettre d’économiser du travail, mais ne fournit pas encore un client complet. C’est-à-dire qu’une adaptation individuelle sera nécessaire. Si le format XML est utilisé, une fonction de désérialisation d’une chaîne XML doit être mise en œuvre.

L’éditeur en ligne Swagger peut créer un client dans de nombreux langages de développement en utilisant la définition de l’API ITscope.

Pour ce faire, le lien suivant https://api.itscope.com/2.1/swagger.json doit être importé dans l’éditeur en ligne Swagger via l’élément de menu File->Import URL…. doivent être importés.

Après l’importation de l’URL, il y a quelques erreurs dans la bonne zone, celles-ci peuvent être ignorées et fermées via le bouton « Effacer ». Le client peut également être généré, malgré ces erreurs affichées.

Ensuite, le client correspondant peut être sélectionné pour le téléchargement via l’élément de menu « Generate Client« .

La liste des clients possibles :

  • Akka Scala
  • Android
  • Async Scala
  • Clojure
  • C#
  • C# .NET 2.0
  • Cwiki
  • Dart
  • Dynamic HTML
  • Flash
  • Go
  • Groovy
  • html
  • html2
  • Java
  • Javascript
  • Javascript Closure Angular
  • Jmeter
  • Objective-C
  • Perl
  • PHP
  • Python
  • QT 5 C++
  • Ruby
  • Scala
  • Swift
  • Tizen
  • Typescript Angular
  • Typescript Angular 2
  • Typescript Fetch
  • Typescript Node

Postman

Pour les utilisateurs de Postman, nous avons créé un projet qui contient tous les points finaux de notre version 2.1 de l’API. Les requêtes sont documentées dans Postman.

Postman peut être téléchargé ici.

Après le téléchargement, Postman vous demandera si vous souhaitez vous enregistrer. Vous pouvez également ignorer l’enregistrement : « Skip signing in and take me straight to the app ».

Le téléchargement du projet Postman se trouve au bas de cette page.

Dans Postman, sélectionnez un espace de travail et appuyez sur Import.

Les variables suivantes sont déjà créées dans Postman et peuvent être remplies avec vos données d’accès API.

VariableDescriptionExemple
baseUrl L’url et la version de l’API ITscope https://api.itscope.com/2.1
Account_IDL’ID de compte ITscope (comme nom d’utilisateur)m123456
API_KEY La clé API (comme mot de passe)abc123de_f456…
Dieses Bild hat ein leeres Alt-Attribut. Der Dateiname ist grafik-2-1024x335.png

Enregistrez les variables. Postman est maintenant prêt à être lancé.

Was this article helpful?
Dislike 0
Views: 45