API:2

ギルドウォーズ2のAPIのバージョン2は、2014年7月16日に root と quaggans のエンドポイントが利用可能になったときに最初に言及されました。2014年9月8日に商取引のエンドポイントが有効になり、2015年2月24日にアカウントのエンドポイントが有効になりました。

このバージョンは、主にインターフェイスの変更であり、アクセスする要素に豊富な構造を導入して、一度に複数のリソースを照会できるようにしました。アカウント情報にアクセスするいくつかのエンドポイントでは、APIキーによる認証が必要ですが、バージョン2はHTTPS経由で公開されています。

アクティブなエンドポイント[]

すべてのエンドポイントのベースURLは https://api.guildwars2.com です。

• /v2/files
• /v2/quaggans
• /v2/pvp
• /v2/races
• /v2/account
• /v2/account/achievements
• /v2/account/bank
• /v2/account/dungeons
• /v2/account/dyes
• /v2/account/finishers
• /v2/account/gliders
• /v2/account/home/cats
• /v2/account/home/nodes
• /v2/account/inventory
• /v2/account/mailcarriers
• /v2/account/masteries
• /v2/account/mastery/points
• /v2/account/materials
• /v2/account/minis
• /v2/account/outfits
• /v2/account/pvp/heroes
• /v2/account/raids
• /v2/account/recipes
• /v2/account/skins
• /v2/account/titles
• /v2/account/wallet
• /v2/characters
• /v2/commerce/delivery
• /v2/commerce/transactions
• /v2/guild/:id
• /v2/guild/:id/log
• /v2/guild/:id/members
• /v2/guild/:id/ranks
• /v2/guild/:id/stash
• /v2/guild/:id/teams
• /v2/guild/:id/treasury
• /v2/guild/:id/upgrades
• /v2/pvp/games
• /v2/pvp/standings
• /v2/pvp/stats
• /v2/tokeninfo
• /v2/achievements/groups
• /v2/achievements/daily/tomorrow
• /v2/achievements/daily
• /v2/achievements/categories
• /v2/achievements
• /v2/backstory/answers
• /v2/backstory/questions
• /v2/build
• /v2/titles
• /v2/traits
• /v2/cats
• /v2/colors
• /v2/commerce/exchange
• /v2/commerce/exchange/coins
• /v2/commerce/exchange/gems
• /v2/commerce/listings
• /v2/commerce/prices
• /v2/continents
• /v2/currencies
• /v2/dungeons
• /v2/emblem
• /v2/finishers
• /v2/gliders
• /v2/guild/permissions
• /v2/guild/search
• /v2/guild/upgrades
• /v2/items
• /v2/itemstats
• /v2/legends
• /v2/mailcarriers
• /v2/maps
• /v2/masteries
• /v2/materials
• /v2/minis
• /v2/nodes
• /v2/outfits
• /v2/pets
• /v2/professions
• /v2/pvp/amulets
• /v2/pvp/heroes
• /v2/pvp/ranks
• /v2/pvp/seasons
• /v2/pvp/seasons/leaderboards
• /v2/raids
• /v2/recipes
• /v2/recipes/search
• /v2/skills
• /v2/skins
• /v2/specializations
• /v2/stories
• /v2/stories/seasons
• /v2/worlds
• /v2/wvw
• /v2/wvw/abilities
• /v2/wvw/matches
• /v2/wvw/matches/stats/teams
• /v2/wvw/objectives
• /v2/wvw/ranks
• /v2/wvw/upgrades
• /v2/commerce
• /v2/account/home
• /v2/backstory
• /v2/guild

リソースへのアクセス[]

各エンドポイントに直接アクセスして、リソースのリストを取得することができます。各リソースは、エンドポイントのサブパスとしてアクセスできます。あるいは、ベースエンドポイントで id クエリパラメータを指定することによって、単一のリソースにアクセスすることもできます。代わりに ids クエリパラメータを指定すると、複数のリソースを指定できます。後者は、コンマで区切られた識別子のリストを期待し、代わりにオブジェクトの配列を返します。

たとえば /v2/quaggans は quaggan の識別子のリストを返します。例："hat" と "box"

• 単一のリソース "hat" quaggan は /v2/quaggans/hat または /v2/quaggans?id=hat でアクセスできます。
• 複数のリソース "hat" と "box" quaggans は /v2/quaggans?ids=hat,box でアクセスできます。

いくつかのリソースは、すべてのリソースを一度に拡張するために ids=all を受け入れます。

ページング[]

エンドポイントは page および page_size クエリパラメータを使用してページングをサポートします。ページを指定すると、すべてのリソースが自動的に展開されます。デフォルトのページサイズは50、最大サイズは現在200です。

ページにアクセスするときは、追加のHTTP応答ヘッダーを使用できます：

• X-Page-Size – ページのサイズ (page_size クエリパラメータなど)
• X-Page-Total – 総ページ数
• X-Result-Count – 現在のページ上のリソースの数 (ページサイズ以下)
• X-Result-Total – リソースの合計数

認証[]

アカウントデータを取得するすべてのエンドポイントでは、APIキーを使用する必要があります。リクエストに沿ってAPIキーを提供するには、現在2つの方法があります。

• Bearer という値を持つリクエストに Authorization HTTP ヘッダーを追加します。
• リクエストURLに ?access_token= というパラメータを追加します。

ローカリゼーション[]

ロケールを認識しているすべてのエンドポイントは、言語パラメーターを受け入れます。現在のところ、この言語パラメータをリクエストとともに提供するには、2つの方法があります。

• の値を持つ Accept-Language HTTP ヘッダーを追加します。これはデフォルトではブラウザーによって設定されます。
• リクエストURLに ?lang= パラメータを追加します。

有効な言語は en, es, de, fr, ko, zh です。言語パラメータが設定されていない場合、言語はデフォルトで en に設定されます。

エラー[]

標準のHTTPステータスコードは、APIの使用時にエラーを表現するために使用されます。さらに、理由に関する追加情報を示すJSON応答 (該当する場合) が返されます。

存在しないエンドポイントを要求すると、HTTP出力コード404が生成されます。

APIキーを指定せずに認証されたエンドポイントを要求したり、無効なキーを指定したりすると、JSON出力でHTTP 403エラーが発生します。

特に記載のない限り、コミュニティのコンテンツはCC BY-SAライセンスの下で利用可能です。