Virtual Organisation:Kommunikation mittels Authentifizierungstoken

From VZ Developer Wiki
Jump to: navigation, search

Schritt für Schritt | <= vorheriger Schritt 1 | Schritt 2 | nächster Schritt 3 =>



Sobald Sie Ihre Credentials haben, können Sie sich am REST-Server authentifizieren. Die Authentifizierung geschieht mit dem folgenden Request:


Beispiel

  • Wichtig: Alle Anfragen müssen über Https (SSL) erfolgen. Eine HTTP-Anfrage wird nicht beantwortet.
  • die Anfrage für einen Authentifizierungstoken muss über die Methode GET abgesetzt werden
  https://vo.apivz.net/Api/Vo/V1/?action=token&username=partner&password=test
  

Bei erfolgreicher Authentifizierung erhalten Sie in der Antwort (Response) einen eindeutigen Token. (Siehe Request: getToken)


Beispiel

  Response Body:
 {
     "meta":
     {
            "version":1,
            "nonce":"",
            "count":1,
            "success":true
     },
     "content":
     {
            "token":"c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b"
     }
 }

Dieser Token (c11ecf449fb37e653c4dd3c66c1dcb104fbfe22b) muss bei allen weiteren Operationen mit angegeben werden. Der Token ist für eine bestimmte Zeit nutzbar und verliert automatisch seine Gültigkeit, wenn keine weiteren Anfragen an den REST-Server gestellt werden. Ist der Token abgelaufen, muss eine erneute Authentifizierung mit Ihrem Benutzernamen und Ihrem Passwort erfolgen.


Ob eine Anfrage erfolgreich war ist im Response-Body, in der meta-Information zu erkennen.

Beispiel

Server-Antwort nach fehlgeschlagendem Request / falscher MethodenName

{"meta":
    {
      "version":1,
      "nonce":"",
      "count":1,
      "success":false
    },
 "content":
    {
      "code":"404",
      "message":"Method getNoMethod is not implemented."
    }
}

Im Attribut "success" kommt im Fehlerfall ein "false" zurück. Weitere Informationen, wie z.B. denn http-code im Attribut "code" und ein Fehlerhinweis im Attribut "message".



Schritt für Schritt | <= vorheriger Schritt 1 | Schritt 2 | nächster Schritt 3 =>