SanctumofRall.com / GW2 API Integration Guide
Moscow
Nov. 14, 2018
12:01 AM MSK
Sydney
Nov. 14, 2018
8:01 AM AEDT
Hobbiton
Nov. 14, 2018
10:01 AM NZDT
Seattle
Nov. 13, 2018
1:01 PM PST
Chicago
Nov. 13, 2018
3:01 PM CST
New York
Nov. 13, 2018
4:01 PM EST
London
Nov. 13, 2018
9:01 PM GMT

SanctumofRall.com / GW2 API Integration Guide

By:

Commander Foghladha.2506
   Site Admin of Gaiscioch na Rall

Posted On: 07/06/2018 at 01:32 PM

Greetings Everyone,

I'm happy to announce that the new SanctumofRall.com is setup to work with the GW2 v2 API. What this means is all verification can be handled by the website rather than requiring people to claim participation or leadership to enable their SOR flag. It also means that when people leave the server I can automatically remove the SOR flag. So I can lock sections away behind the SOR flag to ensure that our private conversations / tools stay somewhat private. (Nothing on the internet is REALLY private now is it?). 

Additionally this allows me to open the doors to registration and allow people to register on their own without the need of a secret code. So to get things started let me go over the basics.

Account Setup & Configuration

Create an API KEY

  1. Go to: https://account.arena.net/ and login
  2. Click "Applications"
  3. Click "New Key"
  4. Set Name to "SanctumofRall.com"
  5. Check "Account, PvP, Characters, ProgressionSee Example
  6. Click "Create API Key"
  7. Copy your API Key to your Clipboard (Control+C)

Add API Key to SanctumofRall.com

  1. Login to: https://www.sanctumofrall.com/ 
  2. Click "Account Settings" on the top right under your ArenaNet.ID
  3. In the API Key field paste your API Key from the instructions above.
  4. Click "Submit Changes"

How will my information be used

The API is designed to be a way for you to share information with other sites. As a firm believer in transparency and honesty here is the scope of what will be used as well as links to my own personal information so you can see a working example of what data is passed from ArenaNet to SanctumofRall.com. All of the information we use is highlighted in Green.

Account

The Account flag allows us to retrieve your "World" to verify that you are on Sanctum of Rall. It will also allow us to verify your ArenaNet.ID and note whether or not you have the commander status unlocked. When combined with the Progression flag we can import and sync your WvW Rank and Fractal Level.

All Information Available via account API:

{
  "id": "426C0E7C-1260-E111-809D-78E7D1936EF0",
  "name": "Foghladha.2506",
  "age": 14350440,
  "world": 1013,
  "guilds": [
    "2ED6C8E6-EC1F-477A-B5D8-0FC554F563E4",
    "C7571761-1A76-4EFA-B40F-945CAD304947",
    "9EBB2BE6-5A23-4C63-8EA2-13539D8427E9",
    "FBEACB6E-975B-4E10-9E52-B4E140F1C3B8",
    "5F852E10-A46F-4E08-9334-EA94FCA3C0C7"
  ],
  "created": "2012-04-25T00:42:00Z",
  "access": [
    "GuildWars2",
    "HeartOfThorns",
    "PathOfFire"
  ],
  "commander": true,
  "fractal_level": 3,
  "daily_ap": 5347,
  "monthly_ap": 1282,
  "wvw_rank": 1627
}

Characters

The Characters flag will enable us to import your characters into the SanctumofRall site so on your profile page you can display your characters and crafting professions. This flag is optional however if it is not provided syncing characters will be skipped.

All Information Available via characters API:

{
  "name": "Foghladha",
  "race": "Human",
  "gender": "Male",
  "flags": [],
  "profession": "Mesmer",
  "level": 80,
  "guild": "C7571761-1A76-4EFA-B40F-945CAD304947",
  "age": 12395757,
  "created": "2012-12-31T08:07:00Z",
  "deaths": 2568,
  "crafting": [
    {
      "discipline": "Armorsmith",
      "rating": 500,
      "active": true
    },
    {
      "discipline": "Chef",
      "rating": 400,
      "active": false
    },
    {
      "discipline": "Artificer",
      "rating": 500,
      "active": false
    },
    {
      "discipline": "Huntsman",
      "rating": 500,
      "active": false
    },
    {
      "discipline": "Jeweler",
      "rating": 400,
      "active": false
    },
    {
      "discipline": "Leatherworker",
      "rating": 500,
      "active": false
    },
    {
      "discipline": "Tailor",
      "rating": 500,
      "active": false
    },
    {
      "discipline": "Weaponsmith",
      "rating": 500,
      "active": false
    },
    {
      "discipline": "Scribe",
      "rating": 400,
      "active": true
    }
  ],
  "title": 188,
  "backstory": [
    "22-109",
    "36-153",
    "21-105",
    "188-188",
    "7-53"
  ],
  "wvw_abilities": [
    {
      "id": 19,
      "rank": 5
    },
    {
      "id": 18,
      "rank": 5
    },
    {
      "id": 15,
      "rank": 4
    },
    {
      "id": 6,
      "rank": 5
    },
    {
      "id": 12,
      "rank": 5
    },
    {
      "id": 3,
      "rank": 5
    },
    {
      "id": 9,
      "rank": 5
    },
    {
      "id": 20,
      "rank": 5
    },
    {
      "id": 10,
      "rank": 5
    },
    {
      "id": 7,
      "rank": 5
    },
    {
      "id": 17,
      "rank": 5
    },
    {
      "id": 14,
      "rank": 4
    },
    {
      "id": 23,
      "rank": 5
    },
    {
      "id": 5,
      "rank": 5
    },
    {
      "id": 2,
      "rank": 5
    },
    {
      "id": 4,
      "rank": 5
    },
    {
      "id": 16,
      "rank": 5
    },
    {
      "id": 11,
      "rank": 5
    },
    {
      "id": 8,
      "rank": 5
    },
    {
      "id": 24,
      "rank": 6
    },
    {
      "id": 25,
      "rank": 5
    }
  ]
}

PvP

The PvP Flag will allow us to pull your win loss record from PvP as well as your PvP rank. This one is optional and mainly used for our sPvP players.

All Information Available via characters API:

{
  "pvp_rank": 17,
  "pvp_rank_points": 41886,
  "pvp_rank_rollovers": 0,
  "aggregate": {
    "wins": 30,
    "losses": 26,
    "desertions": 0,
    "byes": 0,
    "forfeits": 0
  },
  "professions": {
    "mesmer": {
      "wins": 30,
      "losses": 26,
      "desertions": 0,
      "byes": 0,
      "forfeits": 0
    }
  },
  "ladders": {
    "ranked": {
      "wins": 7,
      "losses": 7,
      "desertions": 0,
      "byes": 0,
      "forfeits": 0
    },
    "unranked": {
      "wins": 1,
      "losses": 3,
      "desertions": 0,
      "byes": 0,
      "forfeits": 0
    }
  }
}

Progression

Progression allows us to pull your Fractal and WvW Rank from your Accounts API.

Down the road

I'm hoping that I can create an announcement system that will congratulate our Sanctum of Rall members when they hit major milestones in WvW Rank, PvP Rank, and also server as a way for us to grow closer as a community.

Questions?

If you have questions please feel free to shoot me a message here or on Discord at: @[GSCH] Foghladha#6138. If you would like to review the full API Documentation head over to: https://wiki.guildwars2.com/wiki/API:2 



» Edited on: 2018-07-06 13:33:47



» Edited on: 2018-07-08 15:35:36



» Edited on: 2018-07-08 15:36:15

Benjamin Foghladha
Community Manager, SanctumofRall.com
Founder and Activities Director, The Gaiscioch Family [GSCH]

Reason:


This site is a Gaiscioch Production with the support of the Sanctum of Rall server community. Site Produced by Benjamin "Foghladha" Foley [Foghladha.2506].
This site was built to commemorate and honor the life of Roger "Oldroar" Rall. It is open to the community but under constant moderation. Any use of this site which is deemed unbecoming of an honorable community member is strictly prohibited. No trolling, no trash talking, no bashing, no swearing. Please keep this site open, friendly and welcoming to all members of the Sanctum of Rall server community.

The contents of this site are Copyright © 2012-2018 by: Benjamin Foley. All Rights Reserved