Allgemeine Requestdaten
Die API ist auf dem Allyve-Server immer unter dem Pfad
/api/sociallyve/protected/{methodname}
ausschließlich über https erreichbar. Das SSL-Zertifikat von der allyve-API muss in den Keystore der Consuming-Party integriert werden.
Methodennamen werden immer kleingeschrieben. Folgende Parameter müssen immer vorhanden sein:
| Feld | Beschreibung |
|---|---|
| applicationid | Die Anwendungs-ID der Consuming-Party. |
| timestamp | Der Timestamp der Anfrage als Unixtime. Der Timestamp wird auf Serverseite überprüft und darf maximal 5 Minuten von der auf den Allyve-Servern eingestellten Zeit abweichen. Hierdurch wird sichergestellt, dass eventuell abgefangene Requests nur für einen kurzen Zeitraum verwendbar sind. |
| signature | Die HmacSHA1 Signatur der Request Parameter, URL encoded. Zur Signierung wird der zur applicationId zugehörige applicationSecret verwendet. |
Fehler im Request
Bevor der eigentliche Methodenaufruf durchgeführt wird, überprüft das allyve-Backend die der allgemeinen Parameter „applicationid“, „timestamp“ und „signature“ auf Korrektheit. Tritt hierbei ein Fehler auf, wird die Anfrage mit einem HTTP-Fehlercode 401 (UNAUTHORIZED) abgewiesen. In diesem Fall wird kein Datenobjekt zurückgeliefert, sondern über den „Reason“ der Response wird die Fehlerquelle spezifiziert.
Folgende Meldungen sind möglich:
| Reason | Beschreibung |
|---|---|
| UNAUTHORIZED: INVALID TIMESTAMP | Der angegebene Timestamp weicht um mehr als 5 Minuten von der Serverzeit ab. Mögliche Fehlerquelle kann z.B. eine falsch gesetzte Zeitzone sein. |
| UNAUTHORIZED: UNKNOWN APPLICATION | Zu der angegebenen ApplicationID gibt es keinen Eintrag in der Datenbank. |
| UNAUTHORIZED: INVALID SIGNATURE | Die Signatur konnte nicht erkannt werden. Beim Signieren muß beachtet werden, daß die Parameter in alphabetischer Reihenfolge im Query-Teil der URL vorliegen, da der Server in dieser Reihenfolge die Parameter überprüft. |
Zuletzt aktualisiert am 5. März 2012 von admin - Anmelden