API/v2
Die Version 2 der API wurde am 16.6.2014 in einem zwischenzeitlich gelöschten Tweet eines Entwicklers angekündigt[1]. Sie beinhaltet gegenüber der Version 1 nur wenige neue Endpunkte, bietet jedoch einige Detailverbesserungen wie etwa den Abruf mehrerer IDs mittels einer einzelnen Anfrage und seitenweise Ausgabe der Ergebnisse sowie Sprachunterstützung für Chinesisch (zh) und Koreanisch (ko). Außerdem unterstützt die API v2 Authentifizierung mittels OAuth2, um Anwendungen Zugriff auf verschiedene persönliche Daten eines Accounts zu erlauben.
Endpunkte[Bearbeiten]
Die Basis-URL für alle Endpunkte ist https://api.guildwars2.com/v2/
- account
- build
- characters
- colors
- commerce/exchange
- commerce/exchange/coins
- commerce/exchange/gems
- commerce/listings
- commerce/prices
- commerce/transactions
- continents
- events
- events-state
- files
- floors - entfällt vermutlich und wird mit /v2/continents zusammengelegt [2]
- items
- leaderboards
- maps
- quaggans
- recipes
- recipes/search
- skins
- worlds
- wvw/matches
- wvw/objectives
Anfrageparameter[Bearbeiten]
Für die API v2 existieren verschiedene Anfrageparameter, welche von den meisten Endpunkten unterstützt werden. Wird kein Parameter angegeben, so geben die meisten Endpunkte eine Liste von möglichen Bezeichnern zurück.
- Sprachauswahl
lang- gültige Werte:de,en,es,fr,ko,zh
- Auswahl nach Bezeichner
ids- einer, mehrere mittels Komma getrennte Bezeichner oderall, etwaids=1,2,3. Hierbei ist zu beachten, dassallnicht bei allen Endpunkten funktioniert.
- Seitenweise Auswahl
page- Seitennummerpage_size- Anzahl der Elemente pro Seite
Antwort-Headerfelder[Bearbeiten]
Die API v2 verwendet verschiedene Antwort-Headerfelder, welche zusätzliche Meta-Informationen bieten.
- Anfragen, welche Detailinformationen für einen einzelnen Bezeichner zurückgeben
Content-Language- Sprachcode (ISO 639-1)
- Anfragen, welche Listen von Bezeichnern zurückgeben
X-Result-Total- Gesamtzahl der Elemente
- Anfragen, welche Detailinformationen für mehrere Bezeichner zurückgeben
Content-LanguageX-Result-TotalX-Result-Count- Anzahl der zurückgegebenen Elemente
- Anfragen, welche Detailinformationen für mehrere Bezeichner über mehrere Seiten zurückgeben
Content-LanguageX-Result-TotalX-Result-CountX-Page-Total- Gesamtzahl der SeitenX-Page-Size- Anzahl der Elemente pro Seite
Authentifizierung[Bearbeiten]
Am 24.2.2015 wurde der erste Endpunkt freigeschaltet[3], welcher eine Authentifizierung mittels OAuth2 erfordert. Benutzer können so Webseiten und Anwendungen erlauben, persönliche Daten ihres Accounts wie etwa Accountname, Inventar, Bankinhalt etc. abzurufen. Jede Anfrage an einen solchen Endpunkt erfordert das Anfrage-Headerfeld Authorization mit den Werten Bearer <access token>, wobei <access token> das Token ist, welches die Anwendung vorher während der OAuth2-Authentifizierung erhalten hat.