Fertige API Clients und Generierung des Datenmodells

Last modified: 6. August 2021

Datenmodell aus XML Schema (XSD)

Das Datenmodell als XML Schema (XSD Datei) für die ITscope Datenformate kann über die interaktive API über die API Methode info abgerufen werden. Für diesem Abruf wird kein API Key benötigt. Als URL Pfad wird einfach das Datenausgabeformat gesetzt.

URL zur Schemadefinition für das Datenausgabeformat standard:

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


URL zur Schemadefinition für das Datenausgabeformat standardUpdate:

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


URL zur Schemadefinition für das Datenausgabeformat developer:

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


URL zur Schemadefinition für das Datenausgabeformat developerUpdate:

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


Anleitung für Java

Das Ergebnis des API Abrufs für das Schema je nach Datenformat, also die XML Definition kann dann lokal auf die Festplatte gespeichert werden z.B. unter c:\temp\itscope_api.xsd

Über den Binding Compiler von Java (xjc.exe) kann nun anhand der XML Definition ein Java Klassen Modell erstellt werden.

 
Dieser Aufruf erzeugt ein Package mit dem Namen de.itscope.api.
„c:\Program Files\Java\jdk1.7.0_51\bin\xjc.exe“ -p de.itscope.api c:\temp\itscope_api.xml

Anleitung für C#, .NET und VB.NET

Hierbei handelt es sich nur um Beispieltools oder Anleitungen zum Thema Scheme Generierung.

Swagger API Client für verschiedene Entwickler-Sprachen

Die API Clients können über das von ITscope genutzte öffentliche Framework Swagger (siehe http://www.swagger.io) zur Erstellung von API Datenmodell und API Dokumentation erzeugt werden. Diese Clients sollen als Gerüst für eine Anwendung dienen, das Arbeit ersparen soll, aber noch keinen vollständigen Client abgibt. D.h. individuelle Anpassung werden nötig sei. Sollte das Format XML genutzt werden, muss noch eine Funktion zum Deserialisiern eines XML Strings implementiert werden.

Der Online Swagger Editor kann anhand der ITscope API Definition einen Client in vielen Entwicklungssprachen erzeugen.

Dafür muss folgender Link https://api.itscope.com/2.1/swagger.json in dem Online Swagger Editor über den Menüpunkt File->Import URL… eingespielt werden.

Nach dem Import der URL stehen im rechten Bereich einige Errors, diese können ignoriert werden und über den Button Collapse geschlossen werden. Der Client kann auch generiert werden, trotz dieser angezeigten Errors.

Danach kann über den Menüpunkt Generate Client der jeweilige Client zum Download ausgewählt werden.

Die Liste der möglichen Clients:

  • 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

Für die Nutzer von Postman haben wir ein Projekt erstellt, welches alle Endpunkte unserer API-Version 2.1 enthält. Die Requests sind in Postman dokumentiert, in diesem ITscope Guide Artikel: https://guide.itscope.com/kbtopic/api-und-exporte/ und auch in unserer Interaktiven API: https://guide.itscope.com/kb/interaktive-api/

Postman kann hier heruntergeladen werden.

Nach dem Download werden Sie von Postman gefragt, ob Sie sich registrieren möchten. Sie können die Registrierung aber auch überspringen mit Skip signing in and take me straight to the app (ganz unten in der Postman App).

Im Menüpunkt File -> Import auswählen, und dann im Pop Up Fenster auf Link gehen und folgende URL eintragen:

https://api.itscope.com/2.1/swagger.json

Danach das Projekt über Continue und Import in Postman importieren.

Sie können nun über den linken Baum navigieren und in dem jeweiligen API Bereich die Methoden ausführen. Im Bereich Params müssen dann noch die Parameter für den Abruf eingetragen werden, sofern nötig. Die Bedeutung der jeweiligen Parameter, und ob diese ausgewählt sein müssen, stehen in den entsprechenden Methoden Beschreibungen (siehe https://guide.itscope.com/kbtopic/api-und-exporte/)

Sie benötigen nur noch Ihre Zugangsdaten zur API.

Diese werden in jedem Api Abruf im Bereich Auth als Type Basic Auth hinterlegt.

FeldBeschreibungBeispiel
UsernameDie ITscope Account-ID (als Nutzername)m123456
PasswordDer API-Key (als Passwort)abc123de_f456…

Klicken Sie auf Send um den API Abruf zu starten.

Was this article helpful?
Dislike 0
Views: 610