Webservice API: Unterschied zwischen den Versionen
| Zeile 22: | Zeile 22: | ||
<source lang="text">http://ws.cloud.topdata.de</source> | <source lang="text">http://ws.cloud.topdata.de</source> | ||
<p>Für den Zugang zum Webservice werden Zugangsdaten benötigt die sich wie folgt zusammensetzen. | <p>Für den Zugang zum Webservice werden Zugangsdaten benötigt die sich wie folgt zusammensetzen. | ||
| − | * User ID (uid) | + | * User ID (''%uid%'') |
| − | * Passwort (password) | + | * Passwort (''%password%'') |
| − | * Sicherheitscode (security_key) | + | * Sicherheitscode (''%security_key%'') |
Die Zugangsdaten müssen bei jedem Aufruf des Webservices mit übergeben werden als HTTP Request. | Die Zugangsdaten müssen bei jedem Aufruf des Webservices mit übergeben werden als HTTP Request. | ||
</p> | </p> | ||
<source lang="text">?uid=%uid%&security_key=%security_key%&password=%password%</source> | <source lang="text">?uid=%uid%&security_key=%security_key%&password=%password%</source> | ||
<p>Weiter sind folgende HTTP Request Variablen pflicht um eine Antwort vom Webservice zu erhalten | <p>Weiter sind folgende HTTP Request Variablen pflicht um eine Antwort vom Webservice zu erhalten | ||
| − | * [[Webservice_API#API-Version | + | * [[Webservice_API#API-Version|API-Version]] (''%version%'') |
| − | * Sprache (language) | + | * [[Webservice_API#Sprache|Sprache]] (''%language%'') |
</p> | </p> | ||
<source lang="text">?uid=%uid%&security_key=%security_key%&password=%password%&version=100&language=de</source> | <source lang="text">?uid=%uid%&security_key=%security_key%&password=%password%&version=100&language=de</source> | ||
<h3>API-Version</h3> | <h3>API-Version</h3> | ||
<h3>Sprache</h3> | <h3>Sprache</h3> | ||
Version vom 12. September 2014, 13:06 Uhr
Inhaltsverzeichnis
Webservice API Grundlagen
Nutzung
Der Zugang zum Webservice hat sich an die Webservice Nutzungsbedingungen zu richten.
Zugriffe werden gelogt und ausgewertet. Um Zugriffe/Bandbreite sowie Serverkapazitäten zu sparen wird empfohlen die Anfragen auf den Webservice soweit es geht zu minimieren.
Wir behalten uns das Recht vor Zugänge einzuschränken oder gegebenfalls auch zu sperren.
Zugangsdaten dürfen nicht an Dritte weitergegeben werden oder dargestellt werden.
Datenformat
Der Webservice gibt alles im JSON Format zurück. Wir haben uns gegen XML entschieden da JSON inzwischen genauso weit verbreitet ist und gegenüber XML den Overhead reduziert. Mehr Informationen
Zeichencodierung
Die Ausgabe der Daten des Webservices erfolgt in UFT8
Zugang
Der Zugang zum Webservice erfolgt über eine feste HTTP URL.
http://ws.cloud.topdata.de
Für den Zugang zum Webservice werden Zugangsdaten benötigt die sich wie folgt zusammensetzen.
- User ID (%uid%)
- Passwort (%password%)
- Sicherheitscode (%security_key%)
?uid=%uid%&security_key=%security_key%&password=%password%
Weiter sind folgende HTTP Request Variablen pflicht um eine Antwort vom Webservice zu erhalten
- API-Version (%version%)
- Sprache (%language%)
?uid=%uid%&security_key=%security_key%&password=%password%&version=100&language=de
