Grundsätze der API: Unterschied zwischen den Versionen
| Zeile 1: | Zeile 1: | ||
| − | <div style="border | + | <html> |
| + | <div style="border: 1px solid red; padding: 10px; color: red; font-weight: bold;">Diese Dokumentation ist veraltet. Bitte nutzen Sie <a href="https://client-api.sourcedesk.de" target="_blank">die dedizierte API-Dokumentation</a>.</div> | ||
| + | </html> | ||
Die API steht grundsätzlich unter dem Controller "api" zur Verfügung. Sie erwartet direkt in der URL die Angabe von der Benutzer-ID, dem API-Schlüssel, der Kommando-Gruppe und des auszuführenden Kommandos. | Die API steht grundsätzlich unter dem Controller "api" zur Verfügung. Sie erwartet direkt in der URL die Angabe von der Benutzer-ID, dem API-Schlüssel, der Kommando-Gruppe und des auszuführenden Kommandos. | ||
Aktuelle Version vom 13. Januar 2019, 17:30 Uhr
Die API steht grundsätzlich unter dem Controller "api" zur Verfügung. Sie erwartet direkt in der URL die Angabe von der Benutzer-ID, dem API-Schlüssel, der Kommando-Gruppe und des auszuführenden Kommandos.
Eine Beispiel-URL wäre https://sourceway.de/api/1/api-schluessel/domain/list.
Dadurch wird die API als Benutzer #1 angesprochen, der API-Schlüssel muss hierbei mit dem API-Schlüssel für das entsprechende Konto übereinstimmen. Es wird das Kommando "list" aus der Gruppe "domain" ausgeführt. In diesem Fall werden also alle Domains des Kontos aufgelistet.
Die Rückgabe der API erfolgt immer im JSON-Format. Das kodierte Array besteht immer aus einem "code", wobei hier 100 global einen Erfolgscode darstellt. Global sind noch die Codes 800 (Authentifizierung fehlgeschlagen), 801 (Kommando-Gruppe unbekannt) und 802 (Kommando unbekannt). Die Bedeutung von anderen Codes können Sie in der jeweiligen Kommando-Dokumentation in Erfahrung bringen. Des Weiteren ist im JSON-Array ein Wert "message" enthalten, der den Status-Code auf Englisch beschreibt. Der Wert "data" enthält die eigentliche Rückgabe des Aufrufes und ist je nach Kommando ein Array mit unterschiedlichen Werten.
