RESTful Api (join-restful)

Die RESTful API ist Domain-Sensitiv und über den Endpunkt /rest/v5 erreichbar. 

Request

Parameter

Alle Parameter eines Requests müssen mit Content-Type application/x-www-form-urlencoded URL-kodiert übertragen werden.

Request-Methoden

Es werden 4 gängige HTTP-Request-Methoden verwendet:

Request-Header

Mit Ausnahme der Authentifizierungs-Anfrage muss jeder Request einen Autorisierungs-Header Authorization enthalten, der den zuvor abgeholten Zugriffstoken enthält.

Mehr dazu hier.

Aufbau

Eine RESTful-Ressource setzt sich aus folgenden Teilen zusammen:

• Protokoll
• Hostname (Domain)
• Schlüsselwort für den RESTful-Endpunkt
• Schnittstellen-Version
• Ressourcen-Endpunkt

Beispiel: http://www.meinedomain.com/rest/v5/accessToken

Services

• Datensätze einer Tabelle (List)
• Eltern eines Datensatzes (Parents)
• Karte eines Datensatzes (Card)
• Kinder eines Datensatzes (Children)

Rückgabewerte

Die Response erfolgt immer im JSON-Format mit Content-Type application/json und Charset UTF-8 und enthält folgende Keys:

{
    "body": {
        "token_type": "Bearer",
        "expires_in": 3600,
        "access_token": "abcdefg",
        "refresh_token": "hijkl"
    },
    "code": 0,
    "message": "",
    "extra": []
}

Die Schnittstelle antwortet mit folgenden HTTP-Status-Codes:

Fehler-Codes: Im Fehlerfall wird in message eine Fehlermeldung mit Fehlercode zurückgegeben: