Virtual Organisation:How to

From VZ Developer Wiki
Revision as of 11:15, 11 August 2010 by Ckloeppner (talk | contribs)
Jump to: navigation, search

Inhaltsverzeichnis, API-Methoden, Schritt für Schritt


Auf dieser Seite möchten wir Ihnen eine kurze Schritt für Schritt Anleitung zeigen, die es Ihnen als Partner ermöglicht Edelprofile anzulegen.

Damit Sie bei den VZnet Netzwerken - über die API - Objekte anlegen können, ist ein sogenannter Partner Account Vorraussetzung. Einen solchen Zugang erhalten Sie direkt von uns: zum Kontaktformular.

Wir bieten Ihnen eine REST-Schnittstelle. Sie benötigen einen REST-Client, welcher die Anfragen an unseren REST-Server stellt. Im einfachsten Fall ist dies ein HTTP-Client, wie z.B. das Programm cURL oder eine RESTClient-Erweiterung für Firefox.

Zu einem Partner Account gehört ein eindeutiger Benutzername und ein Passwort. Mit diesen Credentials müssen Sie sich zuerst am REST-Server authentifizieren. Bei erfolgreicher Authentifizierung erhalten Sie in der Antwort (Response) einen eindeutigen Token. (Siehe Request: getToken)

Dieser Token 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. Siehe Authentifizierung.

Wichtig: Alle Anfragen müssen über Https (SSL) erfolgen. Eine http Anfrage wird nicht beantwortet.

Mit einem gültigen Token, können Sie jetzt zum Beispiel ein Edelprofil bei studiVZ/meinVZ oder bei schülerVZ anlegen, editieren oder wieder löschen. Es findet eine strikte Trennung von studiVZ/meinVZ und schülerVZ statt. Ein bei studiVZ/meinVZ angelegtes Edelprofil ist automatisch auch bei der jeweils anderes Plattform sichtbar. Nicht aber bei schülerVZ. Somit müssen Sie bei allen Operationen eine Plattform-ID angeben.

Für studiVZ/meinVZ geben Sie als Plattform-ID die "1" an. Für schülerVZ geben Sie die "2" an.

Wichtig: Ihr Partner Account muss für beide Plattformen (studiVZ/meinVZ und schülerVZ) freigeschaltet sein, sofern Sie auf beiden Plattformen Operationen ausführen möchten.

Mit einem gültigen Token und freigeschalteter Plattform-ID können Sie zum Beispiel alle Ihre bereits angelegten Edelprofile anfordern (siehe Request getProfiles) und weitere REST-API Methoden benutzen.


Inhaltsverzeichnis, API-Methoden, Schritt für Schritt