Mithilfe der Youthweb-API kannst du Apps und Dienste rund um Youthweb bauen. Auf dieser Seite findest du alle Informationen dazu und erhältst Updates über die neusten Änderungen.
Working together
© Rawpixel.com / Fotolia

:tada: Das Neuste aus dem Entwickler-Blog

Weitere Posts findest du in unserem Blog. Du kannst auch unseren RSS-Feed abonnieren.

:book: Dokumentation

Die API ist in API Blueprint definiert und wird mit Aglio zu HTML gerendert.

API Spezifikation ansehen

Aktuelle und ältere Versionen können hier angesehen werden.

Begriffe

  • Resource: Eine Resource ist die Representation eines Objekts, zum Beispiel eines Users. Eine Resource, die vom Youthweb-Server geliefert wird, hat immer mindestens die Attribute type und id. Der Aufbau einer Resource ist in JSON API spezifiziert.
  • Endpoint: Ein Endpoint ist eine Stelle in der Youthweb-API, mit der Daten ausgetauscht werden. Zum Beispiel liefert der Endpoint /users/123 eine Resource, die den User mit der ID 123 representiert. Die übertragenen Daten an einem Endpoint enthalten also in fast allen Fällen eine oder mehrere Resourcen.

Die API ist über https://api.youthweb.net erreichbar.

:key: Autorisierung

Hier kannst du lesen, wie du mit deiner App auf geschützte Resourcen der Youthweb-API zugreifen kannst: OAuth2

:memo: Versionierung

Die API wird immer weiter entwickelt und der aktuelle Stand wird hier festgehalten. Wie das genau funktioniert, findest du hier: Versionierung

:construction_worker: Contribute

Du kannst mithelfen, die Youthweb-API zu gestalten. Hier findest du mehr Informationen dazu: Contribute

:electric_plug: Clients

Diese Clients vereinfachen den Zugriff auf die API. Wenn du einen eigenen Client entwickelt hast, dann gib uns Bescheid und wir ergänzen ihn hier.

PHP

Es gibt einen objektorientierten Client in PHP, der die API abbildet.

:pencil2: Changelog

Der Changelog ist hier zu finden und folgt den Empfehlungen von keepachangelog.com.

Tags: getting_started
Bearbeiten